Spring Cloud Feign Clients 無需 Controller自動暴露Restfu

GeekGhc 發布于2019-08-16 13:39 / 1248人閱讀

摘要：前言在開發應用中，作為聲明式調用的事實標準極大的簡化了遠程調用，提供了類本地化的調用方式。本文介紹一種通過動態代理的方式無需直接暴露接口。后語關于這個框架的介紹，后續詳細的給大家進行介紹。

前言

在開發SpringCloud應用中，Feign作為聲明式調用的事實標準極大的簡化了Rest遠程調用，提供了類本地化的調用方式。服務提供方的接口暴露方式是通過Controller暴露Restful，而在這個Controller的代碼現實中大部分都是處理請求然后再調用Service中的方法，是一個比較模板化的功能，但是工作量確不少。本文介紹一種通過動態代理的方式無需Controller直接暴露Restful接口。
本文中使用筆者在Github開源的框架來實現，本文的講解也在這個框架基礎之上來說明
Git路徑：https://github.com/leecho/spr...

依賴

     
        com.github.leecho
        spring-cloud-starter-feign-proxy
        {last-version}

實現 定義Service Interface

首先定義服務接口，使用@FeignClient標示是一個Feign接口，在這個示例Sevice中定義了CURD和文件上傳方法，并使用了一些常用參數注解

@Api(tags = "DemoService", description = "Demo Feign Client")
@FeignClient("demo-service")
public interface DemoService {

    /**
     * create demo
     *
     * @param demo
     * @return
     */
    @ApiOperation(value = "Create demo")
    @PostMapping(value = "/demo")
    Demo create(@RequestBody @Valid @ApiParam Demo demo);

    /**
     * update demo
     *
     * @param demo
     * @return
     */
    @PutMapping(value = "/demo")
    Demo update(@RequestBody @Valid Demo demo);

    /**
     * delete demo
     *
     * @param id
     * @return
     */
    @DeleteMapping(value = "/demo/{id}")
    Demo delete(@PathVariable(name = "id") String id);

    /**
     * list demo
     *
     * @param id
     * @param headerValue test header value
     * @return
     */
    @GetMapping(value = "/demo/{id}")
    Demo get(@PathVariable(name = "id") String id, @RequestHeader(name = "header") String headerValue);

    /**
     * list demos
     *
     * @return
     */
    @GetMapping(value = "/demos")
    List list();

    /**
     * upload file
     *
     * @param file
     * @return
     */
    @PostMapping(value = "/demo/upload")
    String upload(@RequestPart(name = "file") MultipartFile file);
}

實現Service

在實現類中簡單的實現了CURD和上傳文件的方法

@Slf4j
@Primary
@Service
public class DemoServiceImpl implements DemoService {

    @Override
    public Demo create(Demo demo) {
        log.info("Create executed : " + demo);
        return demo;
    }

    @Override
    public Demo update(Demo demo) {
        log.info("Update execute :" + demo);
        return demo;
    }

    @Override
    public Demo delete(String id) {
        log.info("Delete execute : " + id);
        return Demo.builder().name("demo-" + id).data("data-" + id).build();
    }

    @Override
    public Demo get(String id, String header) {
        Demo demo = Demo.builder()
                .name(header)
                .data(header).build();
        System.out.println("Get execute : " + id + "," + header);
        return demo;
    }

    @Override
    public List list() {
        System.out.println("List execute");
        List demos = new ArrayList<>();
        for (int i = 0; i < 5; i++) {
            Demo demo = Demo.builder()
                    .name("demo-" + i)
                    .data("data" + i).build();
            demos.add(demo);
        }
        return demos;
    }

    @Override
    public String upload(MultipartFile file) {
        return file.getOriginalFilename();
    }
}

動態生成Restful接口的原理是動態生成Controller類實現ServiceInterface，如果真正的實現類會被其他BEAN依賴，需要通過注解@Primary來方式來防止依賴沖突

配置應用

在應用中通過@EnableFeignProxies來標示應用在啟動的過程中會掃描所有的FeignClients并暴露Restful接口

@EnableFeignProxies(basePackages = "com.github.leecho")
@ComponentScan("com.github.leecho")
@SpringBootApplication
public class DemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }

}

測試用例

在測試用例中對Service的接口進行測試

@SpringBootTest
@RunWith(SpringJUnit4ClassRunner.class)
@WebAppConfiguration
public class DemoApplicationTest {
    @Autowired
    private WebApplicationContext context;

    private MockMvc mvc;

    @Before
    public void setUp() {
        mvc = MockMvcBuilders.webAppContextSetup(context).build();
    }

    @Test
    public void create() throws Exception {
        mvc.perform(MockMvcRequestBuilders.post("/demo")
                .contentType(MediaType.APPLICATION_JSON_UTF8)
                .content(new ObjectMapper().writeValueAsString(Demo.builder().name("create").data("data").build()))
                .accept(MediaType.APPLICATION_JSON))
                .andExpect(MockMvcResultMatchers.status().isOk())
                .andDo(MockMvcResultHandlers.print());

    }

    @Test
    public void update() throws Exception {
        mvc.perform(MockMvcRequestBuilders.put("/demo")
                .contentType(MediaType.APPLICATION_JSON_UTF8)
                .content(new ObjectMapper().writeValueAsString(Demo.builder().name("update").data("data").build()))
                .accept(MediaType.APPLICATION_JSON))
                .andExpect(MockMvcResultMatchers.status().isOk())
                .andDo(MockMvcResultHandlers.print());

    }

    @Test
    public void delete() throws Exception {
        mvc.perform(MockMvcRequestBuilders.delete("/demo/{id}", "1")
                .contentType(MediaType.APPLICATION_JSON_UTF8)
                .accept(MediaType.APPLICATION_JSON))
                .andExpect(MockMvcResultMatchers.status().isOk())
                .andDo(MockMvcResultHandlers.print());

    }

    @Test
    public void get() throws Exception {
        mvc.perform(MockMvcRequestBuilders.get("/demo/{id}", "1")
                .contentType(MediaType.APPLICATION_JSON_UTF8)
                .header("header", "header-value")
                .accept(MediaType.APPLICATION_JSON))
                .andExpect(MockMvcResultMatchers.status().isOk())
                .andDo(MockMvcResultHandlers.print());

    }

    @Test
    public void list() throws Exception {
        mvc.perform(MockMvcRequestBuilders.get("/demos")
                .contentType(MediaType.APPLICATION_JSON_UTF8)
                .accept(MediaType.APPLICATION_JSON))
                .andExpect(MockMvcResultMatchers.status().isOk())
                .andDo(MockMvcResultHandlers.print());

    }

    @Test
    public void upload() throws Exception {
        mvc.perform(MockMvcRequestBuilders.multipart("/demo/upload").file(new MockMultipartFile("file", "test.txt", ",multipart/form-data", "upload test".getBytes()))
                .accept(MediaType.APPLICATION_JSON))
                .andExpect(MockMvcResultMatchers.status().isOk())
                .andDo(MockMvcResultHandlers.print());

    }
}

在啟動日志中也可以看到Restful接口已經暴露成功。

后語

關于這個框架的介紹，后續詳細的給大家進行介紹。文中所涉及到的代碼也在Git中：spring-cloud-feign-proxy-sample

文章版權歸作者所有，未經允許請勿轉載,若此文章存在違規行為，您可以聯系管理員刪除。

轉載請注明本文地址：http://specialneedsforspecialkids.com/yun/72096.html

springcloud框架的簡單搭建（消費服務基于feign）

摘要：不過，我們搭建好框架就是為了消費它使用它，那么這篇文章就來看看如何去消費使用我們之前搭建起來的服務吧首先本文是基于上一篇文章進行的。代碼如下啟動程序，多次訪問，瀏覽器顯示內容為至此我們這個服務消費的框架就搭建完畢了。。。上一篇文章主要介紹了如何搭建一個簡單的springcloud框架。不過，我們搭建好框架就是為了消費它使用它，那么這篇文章就來看看如何去消費使用我們之前搭建起來的服務吧...

xiguadada 2019-08-16 17:34 評論0 收藏0
史上最簡單的SpringCloud教程 | 第二篇: 服務消費者（rest+ribbon）

摘要：在服務架構中，業務都會被拆分成一個獨立的服務，服務與服務的通訊是基于的。配置文件如下在工程的啟動類中通過向服務中心注冊并且注冊了一個通過注冊表明，這個是負載均衡的。轉載請標明出處： http://blog.csdn.net/forezp/a...本文出自方志朋的博客在上一篇文章，講了服務的注冊和發現。在服務架構中，業務都會被拆分成一個獨立的服務，服務與服務的通訊是基于http re...

dreamans 2019-08-16 10:31 評論0 收藏0
springCloud學習2(服務發現)

摘要：服務消費者可以使用多種模型來發現服務。客戶端將定期與服務發現層進行通信，并刷新服務實例的緩存。為了達成目的，我們將要學習使用個不同的客戶端庫，服務消費者可以使用它們來和進行交互。本篇代碼存放于:github 一、服務發現架構 ??服務發現架構通常具有下面 4 個概念：服務注冊：服務如何使用服務發現代理進行注冊？服務地址的客戶端查找：服務客戶端查找服務信息的方法是什么？信息共享...

史占廣 2019-08-19 11:43 評論0 收藏0
SpringCloud學習（2）

摘要：此為的結構圖上篇已注冊了，的服務，接下來用，實現負載均衡和的簡單客戶端，讓消費者調用服務。是發布的云中間層服務開源項目，其主要功能是提供客戶側軟件負載均衡算法，將的中間層服務連接在一起。對選定的負載均衡策略機上重試機制。 ??????????上篇已經搭建好基礎demo，接下來繼續構建項目并對spring cloud組件介紹描述。 showImg(https://segmentfault...

wenzi 2019-08-15 12:04 評論0 收藏0