SpringCloud的Feign有哪些注意事项

发布时间:2021-11-16 14:42:35 作者:iii
来源:亿速云 阅读:182

这篇文章主要介绍“SpringCloud的Feign有哪些注意事项”,在日常操作中,相信很多人在SpringCloud的Feign有哪些注意事项问题上存在疑惑,小编查阅了各式资料,整理出简单好用的操作方法,希望对大家解答”SpringCloud的Feign有哪些注意事项”的疑惑有所帮助!接下来,请跟着小编一起来学习吧!

Feign注意事项

*  一、FeignClients使用注意事项:
 *  1. @EnableFeignClients 默认扫描 xxxxApplication启动入口 所在包路径下的 @FeignClient bean,若无法扫描到, 可以在使用Feign调用外部模块的api时候,需要在引用服务中 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 接口对应的实现类,需要使用 @RestController注解 声明
 *  4. mapper注解不支持 : @GetMapping,@PostMapping  , 参数要加 @RequestParam(“xxx”)
 *  5. FeignClient 调用,实质是httpClient调用 ,若我们暴露的接口api,声明了对应的 http mapper 信息,在调用方调用时候,通过代理 发起了 http请求,到服务提供方对应的http服务上去,所以在服务提供方的接口,可以使用 @RestController
 *     来声明接口的 实现,否则调用方无法找到 http 对应的路径,会报404 ;
 *     或者 根据 api 声明的http 信息,构建一个 Controller ,再来调用接口的实现类,但是这样不太方便;

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: 测试服务,注意 Feign的标准写法
 * @date 2019/7/5
 */
@FeignClient(name = "customer-center",path = "customer")
public interface TestService {

    /**
     *  一、FeignClients使用注意事项:
     *  1. @EnableFeignClients 默认扫描 xxxxApplication启动入口 所在包路径下的 @FeignClient bean,若无法扫描到, 可以在使用Feign调用外部模块的api时候,需要在引用服务中 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 接口对应的实现类,需要使用 @RestController注解 声明
     *  4. mapper注解不支持 : @GetMapping,@PostMapping  , 参数要加 @RequestParam(“xxx”)
     *  5. FeignClient 调用,实质是httpClient调用 ,若我们暴露的接口api,声明了对应的 http mapper 信息,在调用方调用时候,通过代理 发起了 http请求,到服务提供方对应的http服务上去,所以在服务提供方的接口,可以使用 @RestController
     *     来声明接口的 实现,否则调用方无法找到 http 对应的路径,会报404 ;
     *     或者 根据 api 声明的http 信息,构建一个 Controller ,再来调用接口的实现类,但是这样不太方便;
     */


    /**
     * 测试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
     * 注意:实现类也要在参数前加 @RequestBody
     */
    @RequestMapping(value = "/test/postUserBo",method = RequestMethod.POST)
    CommonResult<OrgUserBO> postUserBo(@RequestBody  OrgUserBO userBO);

}

接口实现

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);
    }
}

到此,关于“SpringCloud的Feign有哪些注意事项”的学习就结束了,希望能够解决大家的疑惑。理论与实践的搭配能更好的帮助大家学习,快去试试吧!若想继续学习更多相关知识,请继续关注亿速云网站,小编会继续努力为大家带来更多实用的文章!

推荐阅读:
  1. SpringCloud增加Feign日志打印
  2. SpringCloud Feign消费Eureka服务报错

免责声明:本站发布的内容(图片、视频和文字)以原创、转载和分享为主,文章观点不代表本网站立场,如果涉及侵权请联系站长邮箱:is@yisu.com进行举报,并提供相关证据,一经查实,将立刻删除涉嫌侵权内容。

springcloud feign

上一篇:MySQL的binlog的格式及优缺点分别是什么呢

下一篇:Oracle 11gR2 Active DataGuard如何配置Step By Step

相关阅读

您好,登录后才能下订单哦!

密码登录
登录注册
其他方式登录
点击 登录注册 即表示同意《亿速云用户服务条款》