042.SpringCloud 微服务实现

创建Maven工程，配置Pom.xml文件

pom.xml：

<?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>

    <groupId>org.example</groupId>
    <artifactId>heyischool-microservice</artifactId>
    <packaging>pom</packaging>
    <version>1.0-SNAPSHOT</version>


    <properties>
        <!--        springcloud版本要与springboot的版本相互支持-->
        <spring-boot-version>2.4.6</spring-boot-version>
        <spring-cloud-version>2020.0.3</spring-cloud-version>
        <lombok-version>1.18.20</lombok-version>
        <txlcn-version>5.0.0</txlcn-version>
        <commons-lang-version>3.9</commons-lang-version>
        <gson-version>2.8.7</gson-version>
    </properties>

    <!--    统一版本管理-->
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-dependencies</artifactId>
                <version>${spring-boot-version}</version>
            </dependency>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>${spring-cloud-version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <!--            模板依赖自动生成getter、setter等模板代码依赖-->
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
                <version>${lombok-version}</version>
            </dependency>
            <!--            TXLCN事务管理器-->
            <dependency>
                <groupId>com.codingapi.txlcn</groupId>
                <artifactId>txlcn-tm</artifactId>
                <version>${txlcn-version}}</version>
            </dependency>
            <!--            TXLCN分布式事务客户端-->
            <dependency>
                <groupId>com.codingapi.txlcn</groupId>
                <artifactId>txlcn-tc</artifactId>
                <version>${txlcn-version}}</version>
            </dependency>
            <!--            TXLCN事务消息接口的Netty实现-->
            <dependency>
                <groupId>com.codingapi.txlcn</groupId>
                <artifactId>txlcn-txmsg-netty</artifactId>
                <version>${txlcn-version}}</version>
            </dependency>
            <dependency>
                <groupId>org.apache.commons</groupId>
                <artifactId>commons-lang3</artifactId>
                <version>${commons-lang-version}</version>
            </dependency>
            <dependency>
                <groupId>com.google.code.gson</groupId>
                <artifactId>gson</artifactId>
                <version>${gson-version}</version>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <configuration>
                    <source>13</source>
                    <target>13</target>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

创建注册中心Eureka服务

1、创建注册中心服务并配置pom.xml:

<?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">
    <parent>
        <artifactId>heyischool-microservice</artifactId>
        <groupId>org.example</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>heyischool-eureka</artifactId>

    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-server</artifactId>
            <version>2.2.9.RELEASE</version>
        </dependency>
    </dependencies>

<!--    构建Docker镜像-->
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <version>2.5.2</version>
<!--                打包依赖-->
                <executions>
                    <execution>
                        <goals>
                            <goal>repackage</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.8.1</version>
                <configuration>
                    <encoding>utf-8</encoding>
<!--                    源代码使用的JDK开发版本-->
                    <source>15</source>
<!--                    生成的目标class文件的编译版本-->
                    <target>15</target>
                </configuration>
            </plugin>
            <!--            打包生成并上传docker镜像-->
            <plugin>
                <groupId>com.spotify</groupId>
                <artifactId>docker-maven-plugin</artifactId>
                <version>1.2.2</version>
                <configuration>
                    <imageName>${project.name}:${project.version}</imageName>
                    <baseImage>openjdk:15</baseImage>
                    <entryPoint>["java", "-jar", "/${project.build.finalName}.jar"]</entryPoint>
                    <!-- copy the service's jar file from target into the root directory of the image -->
                    <resources>
                        <resource>
                            <targetPath>/</targetPath>
                            <directory>${project.build.directory}</directory>
                            <include>${project.build.finalName}.jar</include>
                        </resource>
                    </resources>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

2、注册中心全局配置

application.yml：

server:
  port: 8081

spring:
  application:
    name: eureka-server

eureka:
  instance:
    prefer-ip-address: true       # 是否使用 ip 地址注册
    instance-id: ${spring.cloud.client.ip-address}:${server.port}   # ip:port
  client:
    register-with-eureka: false   # 是否将自己注册到配置中心，默认为true
    fetch-registry: false         # 是否从注册中心获取服务注册信息，默认为true
    serviceUrl: # 注册中心对外暴露的地址
      defaultZone: http://${eureka.instance.instance-id}/eureka/

3、创建注册中心启动类：

EurekaApplication.java:

package com.faithsinan.eureka;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.eureka.server.EnableEurekaServer;

/**
 * @Author: 司南Sinan weblcx@foxmail.com
 * @Date: 2021/7/20 13:38
 */
@EnableEurekaServer
@SpringBootApplication
public class EurekaApplication {

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

创建网关Gateway服务

1、创建网关服务并编写 Pom.xml

pom.xml:

<?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">
    <parent>
        <artifactId>heyischool-microservice</artifactId>
        <groupId>org.example</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>heyischool-gateway</artifactId>

    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-gateway</artifactId>
        </dependency>
    </dependencies>
</project>

2、API网关全局配置

application.yml：

server:
  port: 8082

eureka:
  instance:
    prefer-ip-address: true
    instance-id: ${spring.cloud.client.ip-address}:${server.port}   # ip:port
  client:
    service-url:
      defaultZone: http://127.0.0.1:8081/eureka/  # 注册中心的地址

spring:
  application:
    name: heyischool-gateway
  cloud:
    gateway:
      enabled: true     # 开启网关服务
      discovery:
        locator:
          enabled: true   # 自动发现
          lower-case-service-id: true   # 是将请求路径上的服务名配置为小写（因为服务注册的时候，向注册中心注册时将服务名转成大写的了）
      routes:
          # 路由的ID，任意起,没有固定规则，但要求唯一，建议配合服务名
        - id: heyischool-tweets
          # 匹配后提供服务的路由地址
		  # 在gateway中配置uri配置有三种方式，包括
		  # 第一种：ws(websocket)方式: uri: ws://localhost:8070
		  # 第二种：http方式: uri: http://localhost:8070/
          # 第三种：lb(注册中心中服务名字)方式: uri: lb://heyischool-tweets
          uri: lb://heyischool-tweets
          # 断言，路径相匹配的进行路由
          predicates:
            - Path=/tweets/**

3、创建网关启动类：

package com.faithsinan.gateway;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

/**
 * @Author: 司南Sinan weblcx@foxmail.com
 * @Date: 2021/7/24 22:36
 * 约定大于配置，在yml配置eureka client后不需要加@EnableEurekaClient
 */
@SpringBootApplication
public class GatewayApplication {

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

创建业务服务示例

1、创建业务服务并编写 Pom.xml

pom.xml:

<?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">
    <parent>
        <artifactId>heyischool-microservice</artifactId>
        <groupId>org.example</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>
    <!--用户中心服务-->
    <artifactId>heyischool-user</artifactId>
    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <configuration>
                    <source>13</source>
                    <target>13</target>
                </configuration>
            </plugin>
        </plugins>
    </build>

    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            <version>${spring-boot-version}</version>
        </dependency>
    </dependencies>
</project>

2、接入注册中心

application.yml:

server:
  port: 8083

spring:
  application:
    name: heyischool-user
    
eureka:
  instance:
    prefer-ip-address: true
    instance-id: ${spring.cloud.client.ip-address}:${server.port}
  client:
    service-url:
      defaultZone: http://127.0.0.1:8081/eureka/

3、创建服务启动类

UserApplication.java:

package com.faithsinan.user;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

/**
 * 用户管理服务
 * @Author: 司南Sinan weblcx@foxmail.com
 * @Date: 2021/7/30 0:18
 */
@SpringBootApplication
public class UserApplication {

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

4、创建请求测试接口：

hello.java:

package com.faithsinan.user.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.*;

import javax.annotation.Resource;

/**
 * @Author: 司南Sinan weblcx@foxmail.com
 * @Date: 2021/7/30 0:40
 */
@Controller
@ResponseBody
@RequestMapping("/user")
public class AdminsController {
    @Resource
    private AdminsService adminsService;


    @RequestMapping("/hello")
    public void hello(){
        
        System.out.println("hello")
    }
}

4、请求测试

在浏览器输入网关地址：http://localhost:8082，服务运行正常则会在控制台输出 ‘hello’字符串。

微服务编译打包并构建镜像部署到 docker

需打包的 pom.xml 文件添加配置：

<!--            打包生成并上传docker镜像-->
            <plugin>
                <groupId>com.spotify</groupId>
                <artifactId>docker-maven-plugin</artifactId>
                <version>1.2.2</version>
                <configuration>
                    <imageName>${project.name}:${project.version}</imageName>
                    <baseImage>openjdk:15</baseImage>
                    <entryPoint>["java", "-jar", "/${project.build.finalName}.jar"]</entryPoint>
                    <!-- copy the service's jar file from target into the root directory of the image -->
                    <resources>
                        <resource>
                            <targetPath>/</targetPath>
                            <directory>${project.build.directory}</directory>
                            <include>${project.build.finalName}.jar</include>
                        </resource>
                    </resources>
                </configuration>
            </plugin>

（1）IDE交互方式：

打包：

idea右侧栏 》Maven 》模块名 》Lifecycle 》package

构建docker镜像并上传到本地仓库：

idea右侧栏 》Maven 》模块名 》Plugins 》docker 》docker:build

（2）用Add Configuration 创建 Maven 命令一键完成

Add New Configuration 》Maven 》working directory（选择项目模块所在目录）》Command line (设置命令)：

clean package docker:build

---

2021年7月31日 稿