Spring Cloud Alibaba集成Nacos和OpenFeign

下文中涉及到的demo，均建立在读者会使用idea工具创建java的maven工程项目，本文中就不再赘述创建工程的步骤了，如不熟悉，请移步该链接学习哦：https://blog.csdn.net/Java_monkeys/article/details/86242428 。创建好的项目框架如下图所示：

上图中红框标出的模块是整个项目的基础，其他组件都将在这基础上扩展。其中gateway是整个项目的入口，所有外部请求都先到达该模块，进行一系列的授权、认证、流量控制、协议转换和路由转发等流程，最终在各个内部微服务之间发起调用请求。admin子系统通过OpenFeign提供了一个最简单的服务接口作为服务调用演示，注册中心使用Nacos。

一、Pom依赖及配置

鉴于各个子服务都会依赖到Spring Cloud Alibaba相关组件，因此将相关依赖放置于顶层pom文件中，避免重复引用。在父级pom文件中引入一下依赖：

    <properties>
        <spring-cloud-alibaba.version>2.1.0.RELEASE</spring-cloud-alibaba.version>
        <spring-cloud.version>Greenwich.SR3</spring-cloud.version>
    </properties>
    <dependencyManagement>
        <dependencies>
            <!-- 整合spring-cloud-alibaba -->
               <dependency>
                <groupId>com.alibaba.cloud</groupId>
                <artifactId>spring-cloud-alibaba-dependencies</artifactId>
                <version>${spring-cloud-alibaba.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>

			  <!-- 整合spring-cloud-->
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>${spring-cloud.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>
	
	<dependencies>
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
        </dependency>
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
			</dependency>
 	</dependencies>

在gateway和admin子服务中引入openfeign依赖：

        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-openfeign</artifactId>
        </dependency>

在各种准备工作就绪后，接下来进入开发环节。首先配置服务的注册中心，在系统启动后，将服务接口暴露出去。在bootstrap.yml进行以下核心配置：

spring:
  application:
    name: spring-cloud-alibaba-admin
  main:
    allow-bean-definition-overriding: true
  cloud:
    nacos:
      discovery:
        server-addr: 127.0.0.1:8848
      config:
        server-addr: 127.0.0.1:8848
server:
  port: 8050

为了方便，注册中心nacos，本文是部署在本地的单机版，也可根据实际使用nacos集群，这里注册中心nacos的使用，不在本文讲解范围，如果需要，请移步http://123.157.158.106:18080/project-43/doc-371/。

二、服务提供者

在进行以上配置后，需要在主程序入口上添加以下注解，否则Feign和注册中心配置不会生效。

首先，定义对外提供服务的接口和实现类：

public interface EchoService {

    /**
     * 对外提供服务的接口
     *
     * @param str 用户输入
     * @return
     */

    String echo(String str);
}

/**
 * @author zhaolc
 * @version 1.0
 * @createTime 2021年08月16日 16:27:00
 */
@Service
public class EchoServiceImpl implements EchoService {

    @Override
    public String echo(String str) {
        return "this is test";
    }
}

通过控制器对外暴露提供的服务：

@RestController
@RequestMapping("/user")
@Slf4j
public class UserController {


    @Autowired
    private EchoService echoService;

    /**
     * 查询
     * @return
     */
    @GetMapping("/echo")
    public String echo(@RequestParam String goodsId){
        return echoService.echo(goodsId);
    }
}

成功启动服务提供者后，出现以下日志说明启动并向nacos注册成功,对外提供服务。

三、服务消费者

服务消费者bootstrap.yml的注册中心相关配置和提供者一致，这里不再重复。
首先，定义服务消费接口，如下所示：

@Component
@FeignClient(name = "spring-cloud-alibaba-admin", fallback = EchoServiceFallback.class)
public interface EchoService {

    /**
     * 调用服务提供方的输出接口
     *
     * @param goodsId 用户输入
     * @return
     */
    @GetMapping(value = "/user/echo")
    String echo(@RequestParam(value = "goodsId") String goodsId);
}

这里有几个注意点：

1. @FeignClient注解中的name值，必须是服务提供者配置文件中的spring.application.name的值，该值是在注册中心的服务名，fallback是定义服务不可用时的，默认服务回调接口，用于返回默认信息。
2. @GetMapping注解中必须是服务提供者的全路径url,否则在注册中心调用不到对应的服务接口

通过控制类对外提供服务：

@RestController
public class UserController {

    @Autowired
    private EchoService echoService;


    @GetMapping(value = "/echo")
    public String echo(@RequestParam String goodsId) {
        return echoService.echo(goodsId);
	}
}

接下来启动服务消费者：

成功启动服务消费者后，出现以下日志说明启动并向nacos注册成功,对外提供服务。

使用PostMan对接口进行测试：

返回"this is test",说明服务调用成功。本文到这里，手把手教学，搭建了一个最基础的微服务框架，但是还远没有达到生产部署要求，所以，接下来的文章，将在此基础上进行扩展，构建一个达到生产环境要求的微服务。

本demo代码地址：https://gitee.com/sarcae/micro-service.git