SpringCloud的Feign有哪些注意事項(xiàng)

這篇文章主要介紹“SpringCloud的Feign有哪些注意事項(xiàng)”，在日常操作中，相信很多人在SpringCloud的Feign有哪些注意事項(xiàng)問題上存在疑惑，小編查閱了各式資料，整理出簡單好用的操作方法，希望對(duì)大家解答”SpringCloud的Feign有哪些注意事項(xiàng)”的疑惑有所幫助！接下來，請(qǐng)跟著小編一起來學(xué)習(xí)吧！

Feign注意事項(xiàng)

*  一、FeignClients使用注意事項(xiàng)：
 *  1. @EnableFeignClients 默認(rèn)掃描 xxxxApplication啟動(dòng)入口 所在包路徑下的 @FeignClient bean，若無法掃描到， 可以在使用Feign調(diào)用外部模塊的api時(shí)候，需要在引用服務(wù)中 xxxxApplication 中的 `@EnableFeignClients(basePackages = "cn.tendyron.customer")` 添加外部包需要掃描FeignClient的路徑,否則無法注入bean
 *  2. @FeignClient 聲明的類，使用 spring.application.name 作為 name配置 @FeignClient(name="xxxx"),如果想保留 context-path , 則需要配置 path 屬性 ，如：@FeignClient(name="xxxx" , path="xxxx（context-path）")
 *  3. @FeignClient 接口對(duì)應(yīng)的實(shí)現(xiàn)類，需要使用 @RestController注解 聲明
 *  4. mapper注解不支持 ： @GetMapping,@PostMapping  ， 參數(shù)要加 @RequestParam（“xxx”）
 *  5. FeignClient 調(diào)用，實(shí)質(zhì)是httpClient調(diào)用 ,若我們暴露的接口api，聲明了對(duì)應(yīng)的 http mapper 信息，在調(diào)用方調(diào)用時(shí)候，通過代理 發(fā)起了 http請(qǐng)求，到服務(wù)提供方對(duì)應(yīng)的http服務(wù)上去，所以在服務(wù)提供方的接口，可以使用 @RestController
 *     來聲明接口的 實(shí)現(xiàn)，否則調(diào)用方無法找到 http 對(duì)應(yīng)的路徑，會(huì)報(bào)404 ；
 *     或者 根據(jù) api 聲明的http 信息，構(gòu)建一個(gè) Controller ，再來調(diào)用接口的實(shí)現(xiàn)類，但是這樣不太方便；

Feign接口定義

package cn.tendyron.customer.api;

import cn.tendyron.common.api.protocol.CommonResult;
import cn.tendyron.customer.bo.OrgUserBO;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;


/**
 * @author CRong.L
 * @ClassName: TestService：
 * @Description: 測試服務(wù)，注意 Feign的標(biāo)準(zhǔn)寫法
 * @date 2019/7/5
 */
@FeignClient(name = "customer-center",path = "customer")
public interface TestService {

    /**
     *  一、FeignClients使用注意事項(xiàng)：
     *  1. @EnableFeignClients 默認(rèn)掃描 xxxxApplication啟動(dòng)入口 所在包路徑下的 @FeignClient bean，若無法掃描到， 可以在使用Feign調(diào)用外部模塊的api時(shí)候，需要在引用服務(wù)中 xxxxApplication 中的 `@EnableFeignClients(basePackages = "cn.tendyron.customer")` 添加外部包需要掃描FeignClient的路徑,否則無法注入bean
     *  2. @FeignClient 聲明的類，使用 spring.application.name 作為 name配置 @FeignClient(name="xxxx"),如果想保留 context-path , 則需要配置 path 屬性 ，如：@FeignClient(name="xxxx" , path="xxxx（context-path）")
     *  3. @FeignClient 接口對(duì)應(yīng)的實(shí)現(xiàn)類，需要使用 @RestController注解 聲明
     *  4. mapper注解不支持 ： @GetMapping,@PostMapping  ， 參數(shù)要加 @RequestParam（“xxx”）
     *  5. FeignClient 調(diào)用，實(shí)質(zhì)是httpClient調(diào)用 ,若我們暴露的接口api，聲明了對(duì)應(yīng)的 http mapper 信息，在調(diào)用方調(diào)用時(shí)候，通過代理 發(fā)起了 http請(qǐng)求，到服務(wù)提供方對(duì)應(yīng)的http服務(wù)上去，所以在服務(wù)提供方的接口，可以使用 @RestController
     *     來聲明接口的 實(shí)現(xiàn)，否則調(diào)用方無法找到 http 對(duì)應(yīng)的路徑，會(huì)報(bào)404 ；
     *     或者 根據(jù) api 聲明的http 信息，構(gòu)建一個(gè) Controller ，再來調(diào)用接口的實(shí)現(xiàn)類，但是這樣不太方便；
     */


    /**
     * 測試Feign Get ，普通處理
     * 注意： @RequestParam("xx") 注解一定要寫，而且屬性名xx不能省略
     */
    @RequestMapping(value = "/test/getUserBo",method = RequestMethod.GET)
    CommonResult<OrgUserBO> getUserBo(@RequestParam("orgCode") String orgCode , @RequestParam("username") String name);


    /**
     * 測試Feign Get Pojo
     */
    @RequestMapping(value = "/test/testUserBo",method = RequestMethod.GET)
    CommonResult<OrgUserBO> testUserBo(OrgUserBO userBO , @RequestParam("token") String token);


    /**
     * 測試Feign Post Pojo
     * 注意：實(shí)現(xiàn)類也要在參數(shù)前加 @RequestBody
     */
    @RequestMapping(value = "/test/postUserBo",method = RequestMethod.POST)
    CommonResult<OrgUserBO> postUserBo(@RequestBody  OrgUserBO userBO);

}

接口實(shí)現(xiàn)

package cn.tendyron.customer.service.impl;

import cn.tendyron.common.api.protocol.CommonResult;
import cn.tendyron.common.util.BeanUtils;
import cn.tendyron.customer.api.AuthService;
import cn.tendyron.customer.api.TestService;
import cn.tendyron.customer.bo.OrgUserBO;
import cn.tendyron.customer.common.constant.BizErrorCodeEnum;
import cn.tendyron.customer.common.constant.Constant;
import cn.tendyron.customer.entity.OrgUserDO;
import cn.tendyron.customer.support.OrgUserSupport;
import com.alibaba.fastjson.JSON;
import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.util.Assert;
import org.springframework.web.bind.annotation.RestController;

import java.util.Objects;
import java.util.concurrent.TimeUnit;

/**
 * @author CRong.L
 * @ClassName: TestServiceImpl
 * @Description:
 * @date 2019/7/5
 */
@Slf4j
@RestController
public class TestServiceImpl implements TestService {

    @Autowired
    RedisTemplate redisTemplate;

    @Override
    public CommonResult<OrgUserBO> getUserBo(String orgCode, String name) {
        return null;
    }

    @Override
    public CommonResult<OrgUserBO> testUserBo(OrgUserBO userBO,String token) {
        log.info("Feign Get Pojo token:{}",token);
        return CommonResult.success(userBO);
    }

    @Override
    public CommonResult<OrgUserBO> postUserBo(OrgUserBO userBO) {

        return CommonResult.success(userBO);
    }
}

到此，關(guān)于“SpringCloud的Feign有哪些注意事項(xiàng)”的學(xué)習(xí)就結(jié)束了，希望能夠解決大家的疑惑。理論與實(shí)踐的搭配能更好的幫助大家學(xué)習(xí)，快去試試吧！若想繼續(xù)學(xué)習(xí)更多相關(guān)知識(shí)，請(qǐng)繼續(xù)關(guān)注億速云網(wǎng)站，小編會(huì)繼續(xù)努力為大家?guī)砀鄬?shí)用的文章！