项目示例 - 1.项目准备

keipace

已于 2024-03-06 11:01:43 修改

阅读量429

点赞数 11

分类专栏：分布式微服务文章标签：分布式微服务后端 spring cloud

于 2024-02-22 17:25:54 首次发布

本文链接：https://blog.csdn.net/keipace/article/details/136239140

版权

分布式微服务专栏收录该内容

24 篇文章 1 订阅

订阅专栏

项目示例 - 1.项目准备

关联知识：

分布式微服务 - 1.介绍 - 2.Spring Cloud
分布式微服务 - 1.介绍 - 3.Spring Cloud Alibaba

内容提要

项目准备：新建父项目、微服务新建示例
公共代码抽离

项目准备

新建父项目

新建项目
Idea设置：打开idea的File/Settings进行设置
- 设置本地maven仓库
  - “Building, Execution, Deployment/Build Tools/Maven”中设置User settings file和Local repository，勾选Override，分别选择配置过镜像地址的settings文件和本地仓库文件夹
- 注解生效激活
  - “Building, Execution, Deployment/Compiler/Annotation Processors”中勾选Enable annotation processing
- Java编译版本
  - “Building, Execution, Deployment/Compiler/Java Compiler”中为项目设置Target bytecode version为java版本
- 显示文件过滤（idea级别设置，设置一次永久生效）
  - “Editor/File Types”中切换Ignored Files and Folders选项卡，添加“.idea”和“.iml”，隐藏文件的显示
- 设置项目编码格式
  - “Editor/File Encodings”中设置Global Encoding、Project Encoding、Default encoding for properties files三项为UTF-8编码格式，并且勾选上Transparent native-to-ascii conversion
目录整理：删除src文件夹
依赖管理：父项目的pom如下配置，注意：Spring Boot3至少需要Java 17或更高版本的Java

<?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>learn</groupId>
    <artifactId>demo</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>pom</packaging>

    <!--  统一管理jar包版本-->
    <properties>
        <maven.compiler.source>17</maven.compiler.source>
        <maven.compiler.target>17</maven.compiler.target>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>

        <spring-cloud.version>2023.0.0</spring-cloud.version>
        <springboot.version>3.2.2</springboot.version>
        <spring-cloud-alibaba.version>2022.0.0.0</spring-cloud-alibaba.version>
    </properties>

    <!-- 1、只是声明依赖，并不实际引入，子项目按需声明使用的依赖 -->
    <!-- 2、子项目可以继承父项目的 version 和 scope -->
    <!-- 3、子项目若指定了 version 和 scope，以子项目为准 -->
    <dependencyManagement>
        <dependencies>
            <!--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>
            <!--Spring Boot-->
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-dependencies</artifactId>
                <version>${springboot.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <!--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>
        </dependencies>
    </dependencyManagement>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <version>${springboot.version}</version>
            </plugin>
        </plugins>
    </build>

</project>

编译项目：双击运行install，显示BUILD SUCCESS

微服务新建示例

演示微服务的新建步骤，后续项目示例中微服务新建时参考此步骤进行。

1. 建Module

idea中在父工程目录上右击选择new/Module，为微服务起名为example
查看父工程pom中发现多了新添加的模块

    <modules>
        <module>example</module>
    </modules>

2. 改pom

为微服务引入所需要的依赖（本示例中仅引入必需的Spring Boot依赖做演示）。

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

3. 写yml

在resources目录下创建application.yml文件并做以下配置（文件图标需要绿叶形状，没有变绿叶的可以在idea的maven窗口中点击刷新按钮）。

server:
  # 微服务访问端口
  port: 8001

spring:
  application:
    # 微服务名称
    name: example

4. 主启动

在Java目录上右击选择New/Java Class
输入类名learn.demo.Example
如下编写主启动类代码

package learn.demo;

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

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

5. 业务构建

根据业务所需，创建数据库表、数据层、服务层、控制层等代码。本示例仅创建controller类作演示。

package learn.demo.controller;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.UUID;

@RestController
@RequestMapping("/example/")
public class ExampleController {
    
    @GetMapping("test")
    public String test() {
        return UUID.randomUUID().toString();
    }
    
}

6. 测试

微服务目录中右击主启动类选择Run 'Example’来启动微服务（同时启动多个微服务时，使用idea 的services窗口方便查看）
在浏览器中输入localhost:8001/example/test 地址，能正确返回随机生成的uuid

公共代码抽离成微服务

1. 公共微服务搭建

建Module：创建common-service微服务
改pom：根据需要引入依赖，本示例中仅引入Lombok作演示

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

公共代码：创建CommonResult类作统一返回类

package demo.common.entities;

import lombok.AllArgsConstructor;
import lombok.Data;

@Data
@AllArgsConstructor
public class CommonResult<T> {

    private Integer code;
    private String message;
    private T data;

    public CommonResult(Integer code, String message) {
        this(code, message, null);
    }

}

mvn：双击运行生命周期中的install，构建成功

2. 其他微服务引用

改pom：在example微服务中，引入自定义的依赖

        <!--引入自定义的公共微服务-->
        <dependency>
            <groupId>learn</groupId>
            <artifactId>common-service</artifactId>
            <version>${project.version}</version>
        </dependency>

业务构建：如下修改controller类

package learn.demo.controller;

import demo.common.entities.CommonResult;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.UUID;

@RestController
@RequestMapping("/example/")
public class ExampleController {

    @GetMapping("test")
    public CommonResult test() {
        return new CommonResult(200, "成功", UUID.randomUUID().toString());
    }

}