【API知識】一種你可能沒見過的Controller形式

本文轉載自查看原文 2019-04-20 16:19 454 Spring

前言

這里分享一下我遇到的一個挺有意思的Controller形式，內容涉及@RequestMapping注解的原理。

實際案例

一、基本描述

項目甲中有多個模塊，其中就有模塊A和B。（這里的模塊指的是Maven的多模塊子項目），項目乙、丙、丁可以引用模塊A來訪問獨立部署的模塊B

模塊A => 關於與模塊B通信的協議定義

模塊B => 可以獨立部署的項目

其中模塊A中定義了一個FeignClient的接口用於訪問模塊B的服務。

@FeignClient(name = "xx-service", url="http://xx-service:8080")
public interface XXXService {
    @PostMapping("/some-url")
    public SomeResponse someOperation(@RequestBody SomeParam param);
    ...
}

我們知道只要打上了@FeignClient注解，我們就可以直接在類中引入這個XXXService，然后調用它的方法。如果我們調用someOperation方法，那它就會根據服務名獲取到IP端口信息，然后發HTTP請求到指定服務xx-service。

二、問題出現

按理說，模塊B肯定有一個Controller來處理這個“/som-url”的請求。於是我全局搜索了模塊B，發現怎么找也找不到“/some-url”。

后來發現模塊B中依賴於模塊A，且有一個類實現了XXXService這個接口。這個類叫XXXServiceImpl。這個類既不叫xxxController，也不帶@Controller注解。

@ResponseBody
@RequestMapping
@Service
public class XXXServiceImpl implements XXXService {
    @Override
    public SomeResponse someOperation(SomeParam param) {
        SomeResponse someResponse = new SomeResponse();
        ...
        return someResponse;
    }
    ...
}

看到@ResponseBody，@RequestMapping，@Service。在我看來這就是一個@RestController了。但是問題來了，還是沒有Mapping。

三、我的一個猜想

我想有沒有可能實現類繼承了接口方法上的注解，於是我看了下@PostMapping的元注解，發現並沒有@Inherited的注解。我也嘗試打印了XXXServiceImpl類someOperation方法上的注解，發現確實沒有。

四、問題解答

XXXServiceImpl確實充當了Controller。關鍵在於針對@RequestMapping的掃描，會向上掃描類的所有父類和接口。只要在接口或者父類的上方法上發現了@RequestMapping的注解，就認定這個方法是某個請求關聯的處理方法。

簡化版本

可能有人不是很理解前面的實際案例，這里提供一個簡化的版本。

一、新建一個只帶Web的Spring Boot項目

二、定義一個接口

這個接口有一個方法，帶有@GetMapping注解。

public interface ControllerInterface {
    @GetMapping("/hello") String hello(); }

三、添加實現類

@RequestMapping
@ResponseBody
@Service
public class ControllerInterfaceImpl implements ControllerInterface { @Override public String hello() { return "hello world"; } }

四、啟動並測試

啟動項目，訪問http://localhost:8080/hello