(二)快速启动、整合log4j2、Swagger

一、项目快速启动

1.修改模块目录

修改模块名称: 将service.main为service.management
service.management作为项目主要后台服务

2.快速启动

1).在management-service-project下的pom.xml中引入springBoot核心jar包 ,包版本为2.1.5.RELEASE

<?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>com.project</groupId>
    <artifactId>management-service-project</artifactId>
    <packaging>pom</packaging>
    <version>1.0-SNAPSHOT</version>
    
    <modules>
        <module>service.common</module>
        <module>service.general</module>
        <module>service.management</module>
    </modules>
    
<dependencies>
    <!-- 1.springBoot依赖包 -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter</artifactId>
        <version>2.1.5.RELEASE</version>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
        <version>2.1.5.RELEASE</version>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-aop</artifactId>
        <version>2.1.5.RELEASE</version>
    </dependency>
</dependencies>

2).创建如下代码代码目录,创建主启动类ServiceApplication 和 application.yml(空内容)配置文件

若为灰色文件夹需设置

ServiceApplication.java类

package com.service.management;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.ComponentScan;


@ComponentScan(basePackages = "com.service")
@SpringBootApplication
public class ServiceApplication {
    public static void main(String[] args) {
        SpringApplication.run(ServiceApplication.class, args);
    }
}

2).启动项目

查看打印日志

日志已打印,服务已启动成功,并未任何报错

二、整合log4j2

通常自带的日志对我们来说并不是很适合定位问题,所以选择使用更广泛的log4j2来重新配置日志。

1.引入log4j2依赖

1).先屏蔽自带日志

<?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>com.project</groupId>
    <artifactId>management-service-project</artifactId>
    <packaging>pom</packaging>
    <version>1.0-SNAPSHOT</version>
    <modules>
        <module>service.common</module>
        <module>service.general</module>
        <module>service.management</module>
    </modules>
    <dependencies>
        <!-- 1.springBoot依赖包 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
            <version>2.1.5.RELEASE</version>
            <exclusions>
                <exclusion>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-starter-logging</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            <version>2.1.5.RELEASE</version>
            <!-- 去掉springboot默认配置 -->
            <exclusions>
                <exclusion>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-starter-logging</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-aop</artifactId>
            <version>2.1.5.RELEASE</version>
        </dependency>
   </dependencies>
</project>

2).引入log4j2 依赖, 为了后期使用方便lombok工具包一并引入

        <!-- 引入log4j2依赖 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-log4j2</artifactId>
            <version>2.1.5.RELEASE</version>
        </dependency>

        <!-- lombok工具包 -->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.16.10</version>
            <scope>provided</scope>
        </dependency>

2.application.yml文件配置日志等级.配置服务器端口:9150

3.创建并配置log4j2.xml

<?xml version="1.0" encoding="UTF-8"?>

<configuration>
    <appenders>
        <console name="Console" target="SYSTEM_OUT">
            <!--输出日志的格式-->
            <PatternLayout charset="UTF-8" pattern="%d{HH:mm:ss.SSS} %5p %c{1}:%L -- %msg%n"/>
        </console>
        <!--文件会打印出所有信息，这个log每次运行程序会自动清空，由append属性决定，适合临时测试用-->
        <RollingFile name="Filelog" fileName="/logs/service.log"
                     filePattern="/logs/info-%d{yyyy-MM-dd}-%i.log">
            <PatternLayout charset="UTF-8" pattern="%d{HH:mm:ss.SSS} %5p %c{1}:%L -- %msg%n"/>
            <SizeBasedTriggeringPolicy size="10 MB"/>
            <DefaultRolloverStrategy max="20"/>
        </RollingFile>
        <!--文件会打印出所有信息，这个log每次运行程序会自动清空，由append属性决定，这个也挺有用的，适合临时测试用-->
        <File name="log" fileName="/logs/running.log" append="false">
            <PatternLayout charset="UTF-8" pattern="%d{HH:mm:ss.SSS} %5p %c{1}:%L -- %msg%n"/>
        </File>
    </appenders>
    <!--Logger节点用来单独指定日志的形式，比如要为指定包下的class指定不同的日志级别等。-->
    <loggers>
        <root level="INFO">
            <appender-ref ref="Console"/>
            <!--<appender-ref ref="Filelog"/>-->
            <appender-ref ref="log"/>
        </root>
    </loggers>
</configuration>

4.启动项目,查看日志

至此期待的日志输出样式和服务器端口已配置成功!

三、整合Swagger

1.完善输出日志

添加如下配置:

每次启动打印出如下日志代表服务启动成功:

2.引入Swagger 依赖

版本:2.9.2

        <!-- 引入swagger依赖 -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>

3.配置Swagger

创建SwaggerConfig.java类

SwaggerConfig类需添加两个注解:@Configuration @EnableSwagger2

package com.service.management;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger.web.UiConfiguration;
import springfox.documentation.swagger.web.UiConfigurationBuilder;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.service"))
                .paths(PathSelectors.any())
                .build();
    }
    private ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                .title("欢迎使用 RESTful API")
                .version("1.0")
                .build();
    }
    @Bean
    public UiConfiguration uiConfig() {
        return UiConfigurationBuilder.builder()
                // 隐藏Models模块
                .defaultModelsExpandDepth(-1)
                .build();
    }
}

4.启动服务器

访问:http://localhost:9150/swagger-ui.html#/

出现如下UI:

5.创建TestSwaggerController.java测试

访问UI:

至此整合Swagger完成

总结

修改service-management模块名称时
及时修改对应的pom.xml文件下artifactId标签

<artifactId>service-management</artifactId>

本次完成了项目快速启动,日志配置,整合Swagger已经初步完成

感谢您看完这篇文章，本人也在学习和摸索中，如有问题，欢迎指正和交流