SpringCloud全家桶（第二期：远程调用Feign）

Bertha 。 2021-10-19 06:12 397阅读 0赞

### 文章目录 ###

*   *  一： 什么是SpringCloud
     *  二：创建两个微服务
     *  三：Feign实现服务间的调用
     *  四：常见错误：

## 一： 什么是SpringCloud ##

> Spring Cloud provides tools for developers to quickly build some of the common patterns in distributed systems (e.g. configuration management, service discovery, circuit breakers, intelligent routing, micro-proxy, control bus, one-time tokens, global locks, leadership election, distributed sessions, cluster state). Coordination of distributed systems leads to boiler plate patterns, and using Spring Cloud developers can quickly stand up services and applications that implement those patterns. They will work well in any distributed environment, including the developer’s own laptop, bare metal data centres, and managed platforms such as Cloud Foundry.

**翻译如下**：

> Spring Cloud为开发人员提供了快速构建分布式系统中的一些常见模式的工具(例如配置管理、服务发现、断路器、智能路由、微代理、控制总线、一次性令牌、全局锁、领导层选举、分布式会话、集群状态)。分布式系统的协调导致了锅炉板模式，使用Spring Cloud开发人员可以快速建立实现这些模式的服务和应用程序。它们在任何分布式环境中都能很好地工作，包括开发人员自己的笔记本电脑、裸机数据中心和云计算等托管平台。

**SpringCloud主要框架**：

*  [服务发现——Netflix Eureka][Netflix Eureka]
 *  [服务调用——Netflix Feign][Netflix Feign]
 *  [熔断器——Netflix Hystrix][Netflix Hystrix]
 *  [服务网关——Netflix Zuul][Netflix Zuul]
 *  [分布式配置——Spring Cloud Config][Spring Cloud Config]
 *  消息总线 —— Spring Cloud Bus

## 二：创建两个微服务 ##

*  pin\_user
 *  pin\_teacher

模拟场景：**老师（服务）要调用学生（服务），他们分别在两个服务中，怎么调用呢？？**

> 需求：老师要查询所有的学生年龄！！

**创建`pin_user`，导入依赖**

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>2.1.7.RELEASE</version>
            <relativePath/> 
        </parent>
        <groupId>com.ml</groupId>
        <artifactId>pin_user</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <name>pin_user</name>
        <description>Demo project for Spring Boot</description>
    
        <properties>
            <java.version>1.8</java.version>
        </properties>
    
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
            <dependency>
                <groupId>org.mybatis.spring.boot</groupId>
                <artifactId>mybatis-spring-boot-starter</artifactId>
                <version>2.1.0</version>
            </dependency>
    		
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <scope>runtime</scope>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-jdbc</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
                <version>2.1.2.RELEASE</version>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
            </dependency>
        </dependencies>
    
        <build>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                </plugin>
            </plugins>
        </build>
    
    </project>

1.创建`application.yml`，加入配置：

server:
      port: 8000
    spring:
      application:
        name: pin-user  #服务名称     （切记不能用写成pin_user）
      datasource:
         driverClassName: com.mysql.cj.jdbc.Driver
         url: jdbc:mysql://localhost:3306/ml?characterEncoding=UTF8&serverTimezone=UTC
         username: root
         password: 123456
      profiles:
        active: dev
    
    
    mybatis:
      mapper-locations: classpath:mapper/**/*.xml
      type-aliases-package:
    
    
    
    eureka:
      client:
        service-url:
          defaultZone: http://localhost:8761/eureka/

2.在启动类上加上注解`@EnableDiscoveryClient`（开启服务发现），`@EnableEurekaClient`（可省略）  
`@MapperScan`:扫描mapper接口  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80Mjc0MDUzMA_size_16_color_FFFFFF_t_70]

`@EnableEurekaClient`（可省略）:因为引入spring-cloud-starter-netflix-eureka-client会默认加上@EnableEurekaClient

查询所有学生接口  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80Mjc0MDUzMA_size_16_color_FFFFFF_t_70 1]

**创建`pin_teacher`，导入pom**

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>2.1.7.RELEASE</version>
            <relativePath/> 
        </parent>
        <groupId>com.ml</groupId>
        <artifactId>pin_teacher</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <name>pin_teacher</name>
        <description>Demo project for Spring Boot</description>
    
        <properties>
            <java.version>1.8</java.version>
        </properties>
    
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
            <dependency>
                <groupId>org.mybatis.spring.boot</groupId>
                <artifactId>mybatis-spring-boot-starter</artifactId>
                <version>2.1.0</version>
            </dependency>
    
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <scope>runtime</scope>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-jdbc</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
                <version>2.1.2.RELEASE</version>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
            </dependency>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-openfeign</artifactId>
                <version>2.1.2.RELEASE</version>
            </dependency>
        </dependencies>
    
        <build>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                </plugin>
            </plugins>
        </build>
    
    </project>

创建`application.yml`,加入以下配置：

server:
      port: 8001
    spring:
      application:
        name: pin-teacher  #服务名称     （切记不能用写成pin_user）
      datasource:
         driverClassName: com.mysql.cj.jdbc.Driver
         url: jdbc:mysql://localhost:3306/ml?characterEncoding=UTF8&serverTimezone=UTC
         username: root
         password: 123456
      profiles:
        active: dev
    
    mybatis:
      mapper-locations: classpath:mapper/**/*.xml
    eureka:
      client:
        service-url:
          defaultZone: http://localhost:8761/eureka/

2.在启动类上加上注解`@EnableDiscoveryClient`（开启服务发现），`@EnableEurekaClient`（可省略）  
`@EnableFeignClients` （用来开启Feign功能）

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80Mjc0MDUzMA_size_16_color_FFFFFF_t_70 2]

## 三：Feign实现服务间的调用 ##

1.在pin\_teacher中模块中添加依赖：

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

提示：在调用者的服务上操作，被调用者的服务无需操作。

2.修改pin\_teacher模块的启动类，添加注解

//开启服务发现功能
    @EnableDiscoveryClient
    //开启Feign功能
    @EnableFeignClients

3.在pin\_teacher模块中，创建com.pin\_teacher.feign,包下创建接口  
com.pin\_teacher.feign.TeacherFeign

import com.ml.pin_teacher.model.Student;
    import org.springframework.cloud.openfeign.FeignClient;
    import org.springframework.web.bind.annotation.RequestMapping;
    
    import java.util.List;
    
    
    @FeignClient("pin-user") //既然是远程调用，那么是调哪个服务呢？这个注解指定微服务的名称，即：pin-user
    public interface TeacherFeign {
    
        @RequestMapping("student")  //要和pin_user中查询所有学生的接口路径完全一致
        List<Student> findAll();
    
    }

`@FeignClient`注解用于指定从哪个服务中调用功能 ，注意 里面的名称与被调用的服务名保持一致，并且不能包含下划线。  
`@GetMapping`或`@RequestMapping`注解用于对被调用的微服务进行地址映射。注意 `@PathVariable`注解一定要指定参数名称，否则出错

4.在`pin_teacher`模块中调用`pin_user`模块中的查询学生方法：

@RestController
    @RequestMapping("teacher")
    public class TeacherController {
    
        @Autowired       //注入Feign的TeacherFeign
        private TeacherFeign teacherFeign;
    
        @RequestMapping("findStudent")
        public List<Student> findAll(){
            List<Student> students = null;
            try {
                students = teacherFeign.findAll();
            } catch (Exception e) {
                e.printStackTrace();
            }
            return students;
        }
    }

5.环境搭建好之后，启动查看是否注册到eureka注册中心上？  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80Mjc0MDUzMA_size_16_color_FFFFFF_t_70 3]  
可见，pin\_teacher和pin\_user服务已经注册到eureka上

**6.调用**

a.通过`pin_user`服务直接调用查询所有学生接口：如下图  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80Mjc0MDUzMA_size_16_color_FFFFFF_t_70 4]

b.通过`pin_teacher`服务直接调用查询所有学生接口：如下图

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80Mjc0MDUzMA_size_16_color_FFFFFF_t_70 5]

## 四：常见错误： ##

*  [java.lang.IllegalStateException: Service id not legal hostname (pin\_user)][java.lang.IllegalStateException_ Service id not legal hostname _pin_user]

**开心一刻**

小孩把妓院养的鹦鹉偷回家，一进门，鹦鹉便叫：搬家啦！看见他妈妈又叫：老板也换啦！看见他姐姐又叫：小姐也换了！看见他爸爸又叫：我cao还是老客！  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80Mjc0MDUzMA_size_16_color_FFFFFF_t_70 6]

如果觉得不错，帮忙点个赞，您的点赞将是我的动力！

[上一篇：服务注册与发现][Netflix Eureka]  
[下一篇：熔断器Hystrix][Netflix Hystrix]

[Netflix Eureka]: https://blog.csdn.net/weixin_42740530/article/details/99684807
[Netflix Feign]: https://blog.csdn.net/weixin_42740530/article/details/99694626
[Netflix Hystrix]: https://blog.csdn.net/weixin_42740530/article/details/99711177
[Netflix Zuul]: https://blog.csdn.net/weixin_42740530/article/details/103958233
[Spring Cloud Config]: https://blog.csdn.net/weixin_42740530/article/details/104519269
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80Mjc0MDUzMA_size_16_color_FFFFFF_t_70]: /images/20211018/3638d74865874be08b0f58c652e9f325.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80Mjc0MDUzMA_size_16_color_FFFFFF_t_70 1]: /images/20211018/0231c53f6c874afea60ff2611b00c793.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80Mjc0MDUzMA_size_16_color_FFFFFF_t_70 2]: /images/20211018/6671e95cce42460fb1d4f654996b130e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80Mjc0MDUzMA_size_16_color_FFFFFF_t_70 3]: /images/20211018/47de88f490914dc189815bfc271b66e7.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80Mjc0MDUzMA_size_16_color_FFFFFF_t_70 4]: /images/20211018/101f868176b646c88d1a40be7df9fb7f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80Mjc0MDUzMA_size_16_color_FFFFFF_t_70 5]: /images/20211018/6cebcb70c2154af9bca324711954ea23.png
[java.lang.IllegalStateException_ Service id not legal hostname _pin_user]: https://blog.csdn.net/weixin_42740530/article/details/99705500
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80Mjc0MDUzMA_size_16_color_FFFFFF_t_70 6]: /images/20211018/7120564072d74b23b7afe53e19ac5fcc.png