SpringBoot构建微服务实战之服务注册

清疚 2022-06-05 12:41 324阅读 0赞

## **SpringBoot构建微服务实战 之 服务注册** ##

本节将以一个实际例子来学习一下使用SpringBoot+Zookeeper来构建微服务之服务的注册。

首先学习本文之前请先了解 [SpringBoot整合Mybatis][SpringBoot_Mybatis]。

--------------------

## **实例** ##

*  创建一个合同(Contract)服务模块。
    
     *  项目结构
        
        ![这里写图片描述][SouthEast]
     *  pom.xml
        
            <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>com.sstps.springBoot</groupId>
                <artifactId>Contract</artifactId>
                <version>0.0.1-SNAPSHOT</version>
                
                <packaging>jar</packaging>
            
                <properties>
                    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
                    <Maven.compiler.source>1.8</Maven.compiler.source>
                    <Maven.compiler.target>1.8</Maven.compiler.target>
                </properties>
            
            
                <dependencyManagement>
                    <dependencies>
                        
                        <dependency>
                            <groupId>org.springframework.boot</groupId>
                            <artifactId>spring-boot-dependencies</artifactId>
                            <version>1.5.8.RELEASE</version>
                            <type>pom</type>
                            <scope>import</scope>
                        </dependency>
                    </dependencies>
                </dependencyManagement>
            
                <dependencies>
            
                    
                    <dependency>
                        <groupId>org.springframework.boot</groupId>
                        <artifactId>spring-boot-starter-jdbc</artifactId>
                    </dependency>
            
                    <dependency>
                        <groupId>org.springframework.boot</groupId>
                        <artifactId>spring-boot-starter-web</artifactId>
                    </dependency>
                    <dependency>
                        <groupId>org.springframework.boot</groupId>
                        <artifactId>spring-boot-starter</artifactId>
                    </dependency>
                    
            
            
                    
                    
                    <dependency>
                        <groupId>mysql</groupId>
                        <artifactId>mysql-connector-java</artifactId>
                        <version>5.1.6</version>
                    </dependency>
            
                    
            
            
                    
                    <dependency>
                        <groupId>org.mybatis</groupId>
                        <artifactId>mybatis</artifactId>
                        <version>3.4.1</version>
                    </dependency>
                    <dependency>
                        <groupId>org.mybatis.spring.boot</groupId>
                        <artifactId>mybatis-spring-boot-starter</artifactId>
                        <version>1.3.0</version>
                    </dependency>
                    
            
                    
                    <dependency>
                        <groupId>junit</groupId>
                        <artifactId>junit</artifactId>
                        <scope>test</scope>
                    </dependency>
                    
            
                    
                    <dependency>
                        <groupId>org.apache.curator</groupId>
                        <artifactId>curator-x-discovery-server</artifactId>
                        <version>2.11.0</version>
                    </dependency>
                    
            
                    
                    <dependency>
                        <groupId>org.springframework.boot</groupId>
                        <artifactId>spring-boot-actuator</artifactId>
                    </dependency>
                    
            
                </dependencies>
            
                <build>
                    <plugins>
                        <plugin>
                            
                            <groupId>org.codehaus.mojo</groupId>
                            <artifactId>appassembler-maven-plugin</artifactId>
                            
                            <version>1.10</version>
                            <configuration>
                                
                                <platforms>
                                    <platform>windows</platform>
                                    <platform>unix</platform>
                                </platforms>
                                
                                <assembleDirectory>${project.build.directory}/market</assembleDirectory>
                                
                                <repositoryName>lib</repositoryName>
                                
                                <binFolder>bin</binFolder>
                                
                                <configurationDirectory>conf</configurationDirectory>
                                
                                <copyConfigurationDirectory>true</copyConfigurationDirectory>
                                
                                <configurationSourceDirectory>src/main/resources</configurationSourceDirectory>
                                
                                <repositoryLayout>flat</repositoryLayout>
                                <encoding>UTF-8</encoding>
                                <logsDirectory>logs</logsDirectory>
                                <tempDirectory>tmp</tempDirectory>
                                <programs>
                                    <program>
                                        
                                        
                                        <id>market</id>
                                        <mainClass>com.sstps.market.App</mainClass>
                                        <jvmSettings>
                                            <extraArguments>
                                                <extraArgument>-server</extraArgument>
                                                <extraArgument>-Xmx2G</extraArgument>
                                                <extraArgument>-Xms2G</extraArgument>
                                            </extraArguments>
                                        </jvmSettings>
                                    </program>
                                </programs>
                            </configuration>
                        </plugin>
                    </plugins>
                </build>
            </project>
     *  ServiceRegistor.java
        
            package com.sstps.market;
            
            import org.apache.curator.framework.CuratorFramework;
            import org.apache.curator.framework.CuratorFrameworkFactory;
            import org.apache.curator.retry.RetryOneTime;
            import org.apache.curator.x.discovery.ServiceDiscovery;
            import org.apache.curator.x.discovery.ServiceDiscoveryBuilder;
            import org.apache.curator.x.discovery.ServiceInstance;
            import org.springframework.beans.factory.annotation.Value;
            import org.springframework.boot.ApplicationArguments;
            import org.springframework.boot.ApplicationRunner;
            import org.springframework.stereotype.Component;
            
            @Component
            public class ServiceRegistor implements ApplicationRunner {
            
                @Value("${zookeeper.address}")
                private String registerAddress;
            
                @Value("${service.address}")
                private String serviceAddress;
            
                @Value("${service.port}")
                private Integer servicePort;
            
                public void run(ApplicationArguments args) throws Exception {
                    //注册中心
                    CuratorFramework client = CuratorFrameworkFactory.newClient(registerAddress, new RetryOneTime(1000));
                    client.start();
                    client.blockUntilConnected();
            
                    //注册服务
                    ServiceInstance <Object> instance = ServiceInstance.builder().name("contract").address(serviceAddress).port(servicePort).build();
            
                    ServiceDiscovery<Object> serviceDiscovery = ServiceDiscoveryBuilder.builder(Object.class).client(client).basePath("/sstps").build();
            
                    serviceDiscovery.registerService(instance);
                    serviceDiscovery.start();
                    System.out.println("Registe successed");
            
            
            
                }
            
            }
        
        代码解读：使用 CuratorFramework 来实现服务的注册。Curator对Zookeeper JAVA API做了高度封装。
     *  application.properties
        
            spring.datasource.url=jdbc:mysql:///sstps_product?useSSL=false&serverTimezone=UTC
            spring.datasource.username=root
            spring.datasource.password=bai5331359
            spring.datasource.tomcat.driver-class-name=com.mysql.jdbc.Driver
            spring.jackson.date-format=yyyy-MM-dd HH:mm:ss
            
            server.port=9090
            zookeeper.address=192.168.100.19:2181
            
            service.address=192.168.100.19
            service.port=9090
            
            management.security.enabled=false
     *  其他java代码就是基本SSM业务逻辑代码来实现增删改查的基本功能，这里就不展示了。核心代码在服务的注册。
     *  App.java
        
            package com.sstps.market;
            
            import org.springframework.boot.SpringApplication;
            import org.springframework.boot.autoconfigure.SpringBootApplication;
            import org.springframework.context.ConfigurableApplicationContext;
            import org.springframework.context.annotation.ComponentScan;
            
            import com.sstps.market.entity.Contract;
            import com.sstps.market.mapper.ContractMapper;
            
            @SpringBootApplication
            @ComponentScan("com.sstps.market")
            public class App {
            
                /** * 微服务， 把原来一个大的系统拆分成小的系统，每一小的系统 单独 开发。测试、维护 * * 常用的服务注册中心有： Zookeeper、consul、etcd、redis * 服务提供方需要在服务启动的时候把服务的信息注册到注册中心去(Zookeeper)。 * @param args */
                public static void main(String[] args) {
            
                    ConfigurableApplicationContext context = SpringApplication.run(App.class, args);
                    context.getBean(ContractMapper.class);
            
            
                }
            
            }
 *  创建一个市场模块(Market)
    
     *  项目结构
        
        ![这里写图片描述][SouthEast 1]
     *  application.properties
        
            spring.datasource.url=jdbc:mysql:///sstps_product?useSSL=false&serverTimezone=UTC
            spring.datasource.username=root
            spring.datasource.password=bai5331359
            spring.datasource.tomcat.driver-class-name=com.mysql.jdbc.Driver
            spring.jackson.date-format=yyyy-MM-dd HH:mm:ss
            
            
            zookeeper.address=192.168.100.19:2181
            
            service.address=192.168.100.19
            service.port=8080
            
            management.security.enabled=false
     *  ServiceRegistor.java
        
            package com.sstps.market;
            
            import org.apache.curator.framework.CuratorFramework;
            import org.apache.curator.framework.CuratorFrameworkFactory;
            import org.apache.curator.retry.RetryOneTime;
            import org.apache.curator.x.discovery.ServiceDiscovery;
            import org.apache.curator.x.discovery.ServiceDiscoveryBuilder;
            import org.apache.curator.x.discovery.ServiceInstance;
            import org.springframework.beans.factory.annotation.Value;
            import org.springframework.boot.ApplicationArguments;
            import org.springframework.boot.ApplicationRunner;
            import org.springframework.stereotype.Component;
            
            @Component
            public class ServiceRegistor implements ApplicationRunner {
            
                @Value("${zookeeper.address}")
                private String registerAddress;
            
                @Value("${service.address}")
                private String serviceAddress;
            
                @Value("${service.port}")
                private Integer servicePort;
            
                public void run(ApplicationArguments args) throws Exception {
                    //注册中心
                    CuratorFramework client = CuratorFrameworkFactory.newClient(registerAddress, new RetryOneTime(1000));
                    client.start();
                    client.blockUntilConnected();
            
                    //注册服务
                    ServiceInstance <Object> instance = ServiceInstance.builder().name("market").address(serviceAddress).port(servicePort).build();
            
                    ServiceDiscovery<Object> serviceDiscovery = ServiceDiscoveryBuilder.builder(Object.class).client(client).basePath("/sstps").build();
            
                    serviceDiscovery.registerService(instance);
                    serviceDiscovery.start();
                    System.out.println("Registe successed");
            
            
            
                }
            
            }
     *  App.java
        
            package com.sstps.market;
            
            import org.springframework.boot.SpringApplication;
            import org.springframework.boot.autoconfigure.SpringBootApplication;
            import org.springframework.context.ConfigurableApplicationContext;
            import org.springframework.context.annotation.ComponentScan;
            import org.springframework.transaction.annotation.Transactional;
            
            import com.sstps.market.mapper.ProductMapper;
            
            @SpringBootApplication
            @ComponentScan("com.sstps.market")
            public class App {
            
                /** * 微服务， 把原来一个大的系统拆分成小的系统，每一小的系统 单独 开发。测试、维护 * * 常用的服务注册中心有： Zookeeper、consul、etcd、redis * 服务提供方需要在服务启动的时候把服务的信息注册到注册中心去(Zookeeper)。 * @param args */
                public static void main(String[] args) {
            
                    ConfigurableApplicationContext context = SpringApplication.run(App.class, args);
                    context.getBean(ProductMapper.class);
            
            
                }
            
            }

--------------------

*  开启Zookeeper服务(以windos OS 为例)  
    首先现在本安装一个Zookeeper的服务，关于zookeeper将在以后讲解，请关注本人csdn微博~
    
     *  Server
        
        ![这里写图片描述][SouthEast 2]
     *  Client
        
        ![这里写图片描述][SouthEast 3]
 *  启动Contract 和 Market两个服务，然后查看Zookeeper。
    
    ![这里写图片描述][SouthEast 4]
    
    此时我们的服务边注册到了Zookeeper中去了。

--------------------

## **小结** ##

*  微服务的注册使用的是 Curator，当然你也可以使用ZClient等。因人而异。
 *  服务的注册核心代码：
    
     *  使用 CuratorFramework 来实现服务的注册因为 Curator 提供了更为高效简介易用的 JAVA API。
     *  实现ApplicationRunner接口。该接口中的实现类的方法将在 SpringBoot 启动服务以后调用。

[SpringBoot_Mybatis]: http://blog.csdn.net/u012437781/article/details/78630860
[SouthEast]: /images/20220605/4b0b621a12b447b0bc6f7d74bc07bcd1.png
[SouthEast 1]: /images/20220605/620e3cacfc804eb996ecf567adf3f26c.png
[SouthEast 2]: /images/20220605/f59f18db85864aea9404a0a59b7f70c9.png
[SouthEast 3]: /images/20220605/688d76d4fd3b4a14985d6b082aafedc9.png
[SouthEast 4]: /images/20220605/35038c1200c247c79896204fdf1b0055.png