0
点赞
收藏
分享

微信扫一扫

带你快速体验一次简单的Spring Cloud的微服务（玩具服务）————附带详细代码

郝春妮 2022-05-25 阅读 38
Spring Boot微服务Spring CloudspringmavenOpenStack云计算



文章目录

  • ​​0 背景​​
  • ​​1 创建项目​​
  • ​​2 创建微服务​​
  • ​​附录​​
  • ​​父项目的pom.xml​​
  • ​​子pom.xml​​

0 背景

本文只是为了给想体验Spring Cloud微服务项目的同学快速上手的一个玩具项目（本人也并非专业的Java网页开发，也只是想花很短的时间体验一下微服务），目的只有一个体验一下Spring Cloud。这里首先创建一个简单Sprong Boot项目，下一期再进行微服务的操作，例如服务注册、负载均衡、容错保护（服务降级、服务熔断、请求缓存、请求合并、依赖隔离）等。

如果想系统的学习，可以根据相关的书籍进行学习。

1 创建项目

由于一个微服务项目中包含着很多子项目，这里首先建立一个大的父项目，然后再在父项目下创建其余的子项目。

这里开始创建父项目：

  • 1，新建一个​​Spring Initializr​​​项目(如果觉得国外的服务器(​​Server URL​​​)网址慢，可以换成国内的)，根据自己情况填写​​Name​​​（项目名称）、​​Group​​​（项目组织唯一的标识符，实际对应JAVA的包的结构，是main目录里java的目录结构）、​​Artifact​​​(项目的唯一的标识符，实际对应项目的名称，就是项目根目录的名称、​​Package name​​​(包名)、​​Project SDD​​​(项目的Software Development Kit)、​​Java​​(Java版本)；

带你快速体验一次简单的Spring Cloud的微服务（玩具服务）————附带详细代码_maven

  • 2，选择​​SPring Boot​​​的版本，然后选择相关的依赖（这里未进行任何依赖的选择，后面​​.pom​​文件中可以配置）；

带你快速体验一次简单的Spring Cloud的微服务（玩具服务）————附带详细代码_maven_02

  • 3，创建完成后，删除其余的文件，只保留如下面第二张图的结构；

带你快速体验一次简单的Spring Cloud的微服务（玩具服务）————附带详细代码_spring_03

带你快速体验一次简单的Spring Cloud的微服务（玩具服务）————附带详细代码_spring_04

  • 4，更改maven仓库配置，设置自己的​​Mavne home path​​​（maven版本），​​Local resposity​​​仓库，​​Use setting file​​​配置文件，然后点击​​Application​​​，再点击​​Save​​​；
    带你快速体验一次简单的Spring Cloud的微服务（玩具服务）————附带详细代码_Spring Cloud_05
    带你快速体验一次简单的Spring Cloud的微服务（玩具服务）————附带详细代码_spring_06
    然后再设置​​​pom.xml​​​自动更新，勾选​​Any Changes​​；

带你快速体验一次简单的Spring Cloud的微服务（玩具服务）————附带详细代码_maven_07

带你快速体验一次简单的Spring Cloud的微服务（玩具服务）————附带详细代码_微服务_08

  • 5，配置父​​pom.xml​​（完整配置见附录）；

添加父模块：

<parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.13.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

项目信息(​​packaging​​​不添加，会报错​​'packaging' with value 'jar' is invalid​​)：

<groupId>com.jk</groupId>
    <artifactId>SpringCloudTest2</artifactId>
    <version>1.0-SNAPSHOT</version>
    <name>SpringCloudTest2</name>
    <packaging>pom</packaging>
    <description>SpringCloudTest2</description>

添加指定版本的说明:

<properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
        <jacoco.version>0.8.3</jacoco.version>
    </properties>

添加相关依赖（这里多了一个​​jacoco​​，用于单元测试）：

<dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>

        <dependency>
            <groupId>org.jacoco</groupId>
            <artifactId>jacoco-maven-plugin</artifactId>
            <version>0.8.3</version>
        </dependency>
    </dependencies>

添加构建说明（这里主要都是jacoco的构建）：

<build>
        <plugins>
            <plugin>
                <groupId>org.jacoco</groupId>
                <artifactId>jacoco-maven-plugin</artifactId>
                <version>${jacoco.version}</version>
                <configuration>
                    <includes>
                        <include>**/*</include>
                    </includes>
                    <destFile>SpringCloudTest/cloud-jk-1/target/jacoco.exec</destFile>
                    <!-- rules裏面指定覆蓋規則 -->
                    <rules>
                        <rule implementation="org.jacoco.maven.RuleConfiguration">
                            <element>BUNDLE</element>
                            <limits>　　
                                <!-- 指定方法覆蓋到50% -->
                                <limit implementation="org.jacoco.report.check.Limit">
                                    <counter>METHOD</counter>
                                    <value>COVEREDRATIO</value>
                                    <minimum>0.50</minimum>
                                </limit>
                                <!-- 指定分支覆蓋到50% -->
                                <limit implementation="org.jacoco.report.check.Limit">
                                    <counter>BRANCH</counter>
                                    <value>COVEREDRATIO</value>
                                    <minimum>0.50</minimum>
                                </limit>
                                <!-- 指定類覆蓋到100%，不能遺失任何類 -->
                                <limit implementation="org.jacoco.report.check.Limit">
                                    <counter>CLASS</counter>
                                    <value>MISSEDCOUNT</value>
                                    <maximum>0</maximum>
                                </limit>
                            </limits>
                        </rule>
                    </rules>
                </configuration>
                <executions>
                    <execution>
                        <id>pre-test</id>
                        <goals>
                            <goal>prepare-agent</goal>
                        </goals>
                    </execution>
                    <execution>
                        <id>post-test</id>
                        <phase>test</phase>
                        <goals>
                            <goal>report</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

2 创建微服务

  • 1，创建子模块；

带你快速体验一次简单的Spring Cloud的微服务（玩具服务）————附带详细代码_Spring Cloud_09

  • 2，配置内容根据自己实际情况填写，然后选择maven版本后，点击完成；
    带你快速体验一次简单的Spring Cloud的微服务（玩具服务）————附带详细代码_Spring Cloud_10
    带你快速体验一次简单的Spring Cloud的微服务（玩具服务）————附带详细代码_Spring Boot_11
  • 3，修改​​pom.xml​​；

添加父模块：

<parent>
        <artifactId>SpringCloudTest2</artifactId>
        <groupId>com.jk</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>

添加项目信息：

<artifactId>cloud-1</artifactId>
    <name>cloud-1</name>
    <description>cloud-1</description>

添加版本说明：

<properties>
        <java.version>1.8</java.version>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <spring-cloud.version>Greenwich.SR5</spring-cloud.version>
    </properties>

添加依赖：

添加依赖管理：

<dependencyManagement>
        <dependencies>
            <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>

添加构建：

<build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <excludes>
                        <exclude>
                            <groupId>org.projectlombok</groupId>
                            <artifactId>lombok</artifactId>
                        </exclude>
                    </excludes>
                </configuration>
            </plugin>
        </plugins>
    </build>
  • 4,添加Spring Boot的组件，新建​​entity​​​文件夹（实体）和​​Student​​类；

带你快速体验一次简单的Spring Cloud的微服务（玩具服务）————附带详细代码_Spring Cloud_12

编写如下代码（lombok会自动帮忙生成实体Bean中大量的Getter/Setter方法，以及toString, hashCode代码）：

package com.jk.cloud1.entity;

import lombok.Data;

@Data
public class StudentEntity {

    //姓名
    private String name;
    //年龄
    private int age;
    //备注
    private String remark;
}
  • 5，添加Spring Boot的组件，新建​​controller​​​文件夹和​​StudentController​​类；

带你快速体验一次简单的Spring Cloud的微服务（玩具服务）————附带详细代码_微服务_13

编写如下代码：

package com.jk.cloud1.controller;

import com.jk.cloud1.entity.StudentEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import org.apache.commons.lang.StringUtils;


/**
 *  <p>
 *      学生模块，控制器
 *  </p>
 * */
@RestController
@RequestMapping(value = "/student")
public class StudentController {

    /**
     * 获取一个学生
     * @return JSON对象
     */
    @GetMapping(value = "/detail")
    public Object getStudent () throws InterruptedException {
        //模拟超时（用于显示熔断器Hystrix的作用）
//        TimeUnit.SECONDS.sleep(6);

        StudentEntity student = new StudentEntity();
        student.setName("张三");
        student.setAge(18);
        student.setRemark("");
        return student;
    }

    @GetMapping(value =  "/detail2/{var}")
    public Object getStudent2(@PathVariable String var) throws InterruptedException{
        StudentEntity student = new StudentEntity();
        student.setName("张三");
        student.setAge(18);
        if (StringUtils.isNotEmpty(var) ){
            student.setRemark(var);
        }else {
            student.setRemark("");
        }


        return student;
    }
}

  • 7，编写应用网页端口和ip，文件如下的路径，把​​application.properities​​改为​​application.yml​​(​​properities​​的优先级高，​​yml​​的文件编码风格更好)；

    带你快速体验一次简单的Spring Cloud的微服务（玩具服务）————附带详细代码_Spring Boot_14

  • 7，编写单元测试用例，路径如下图(如果进行测试，可以删除test文件夹)；

    带你快速体验一次简单的Spring Cloud的微服务（玩具服务）————附带详细代码_微服务_15

    编写如下代码：

package com.jk.cloud1;

import com.jk.cloud1.controller.StudentController;
import com.jk.cloud1.StudentControllerTest;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;

import javax.annotation.Resource;

@RunWith(SpringRunner.class)
@SpringBootTest(classes = Cloud1Application.class)
public class StudentControllerTest {
    @Resource
    StudentController studentController;

    @Test
    public void test() throws InterruptedException {
        studentController.getStudent2("handsome");
    }
}
  • 8,运行启动应用（​​Cloud1Application.java​​）；

带你快速体验一次简单的Spring Cloud的微服务（玩具服务）————附带详细代码_微服务_16

  • 9，访问接口对应的网页；
    带你快速体验一次简单的Spring Cloud的微服务（玩具服务）————附带详细代码_Spring Boot_17
    带你快速体验一次简单的Spring Cloud的微服务（玩具服务）————附带详细代码_maven_18

至此spring cloud的项目可以说已经小小的体验了一把。

附录

父项目的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 https://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.13.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

    <modules>
        <module>
            cloud-1
        </module>
    </modules>

    <groupId>com.jk</groupId>
    <artifactId>SpringCloudTest2</artifactId>
    <version>1.0-SNAPSHOT</version>
    <name>SpringCloudTest2</name>
    <packaging>pom</packaging>
    <description>SpringCloudTest2</description>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
        <jacoco.version>0.8.3</jacoco.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
            <exclusions>
                <exclusion>
                    <groupId>org.junit.vintage</groupId>
                    <artifactId>junit-vintage-engine</artifactId>
                </exclusion>
            </exclusions>
        </dependency>

        <dependency>
            <groupId>org.jacoco</groupId>
            <artifactId>jacoco-maven-plugin</artifactId>
            <version>0.8.3</version>
        </dependency>
    </dependencies>


    <build>
        <plugins>
            <plugin>
                <groupId>org.jacoco</groupId>
                <artifactId>jacoco-maven-plugin</artifactId>
                <version>${jacoco.version}</version>
                <configuration>
                    <includes>
                        <include>**/*</include>
                    </includes>
                    <destFile>SpringCloudTest/cloud-jk-1/target/jacoco.exec</destFile>
                    <!-- rules裏面指定覆蓋規則 -->
                    <rules>
                        <rule implementation="org.jacoco.maven.RuleConfiguration">
                            <element>BUNDLE</element>
                            <limits>　　
                                <!-- 指定方法覆蓋到50% -->
                                <limit implementation="org.jacoco.report.check.Limit">
                                    <counter>METHOD</counter>
                                    <value>COVEREDRATIO</value>
                                    <minimum>0.50</minimum>
                                </limit>
                                <!-- 指定分支覆蓋到50% -->
                                <limit implementation="org.jacoco.report.check.Limit">
                                    <counter>BRANCH</counter>
                                    <value>COVEREDRATIO</value>
                                    <minimum>0.50</minimum>
                                </limit>
                                <!-- 指定類覆蓋到100%，不能遺失任何類 -->
                                <limit implementation="org.jacoco.report.check.Limit">
                                    <counter>CLASS</counter>
                                    <value>MISSEDCOUNT</value>
                                    <maximum>0</maximum>
                                </limit>
                            </limits>
                        </rule>
                    </rules>
                </configuration>
                <executions>
                    <execution>
                        <id>pre-test</id>
                        <goals>
                            <goal>prepare-agent</goal>
                        </goals>
                    </execution>
                    <execution>
                        <id>post-test</id>
                        <phase>test</phase>
                        <goals>
                            <goal>report</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>


            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

子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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <parent>
        <artifactId>SpringCloudTest2</artifactId>
        <groupId>com.jk</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>

    <artifactId>cloud-1</artifactId>
    <name>cloud-1</name>
    <description>cloud-1</description>

    <properties>
        <java.version>1.8</java.version>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <spring-cloud.version>Greenwich.SR5</spring-cloud.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>commons-lang</groupId>
            <artifactId>commons-lang</artifactId>
            <version>2.6</version>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-websocket</artifactId>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>

    </dependencies>

    <dependencyManagement>
        <dependencies>
            <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>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <excludes>
                        <exclude>
                            <groupId>org.projectlombok</groupId>
                            <artifactId>lombok</artifactId>
                        </exclude>
                    </excludes>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>



举报

相关推荐

简单了解 Spring Cloud 的微服务架构

日记本SpringBoot架构

Spring Cloud微服务

微服务架构云原生

Spring Cloud 微服务

支持向量机机器学习人工智能

微服务架构的服务与发现-Spring Cloud

日记本springbootspringc...我爱编程tech微服务实践架构学习

微服务系列：服务调用 Spring Cloud 之 OpenFeign 详细入门

spring cloudOpenFeignfeign微服务

微服务鉴权代码实现（Spring Cloud）

Spring CloudjavaWeb学习

微服务 – Spring Cloud – OpenFeign的使用

java微服务封装架构后端开发

微服务 – Spring Cloud – Stream

idespringjavaJava后端开发

spring cloud 微服务治理

微服务springdockerPython后端开发

微服务 – Spring Cloud – Rabbion

javajsonServer架构后端开发
0 条评论