【读官方文档，学原味技术】SpringBoot-Staters和自定义Starter〔案例〕

本文链接：https://blog.youkuaiyun.com/u011698550/article/details/103685690

本文详细介绍如何从零开始创建自定义Spring Boot Starter，包括配置功能实现、日志功能开发、自动配置添加及测试工程搭建过程。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

如果不想阅读英文原文，你可以直接读本文的【TS】标注参考翻译内容。由于本人水平有限，如有理解错误，烦请指正，互相交流。
Lire les documents officiels et apprendre les techniques originales.
【TS】读官方文档，学原味技术。

读官方文档，学原味技术！

本文是接《【读官方文档，学原味技术】SpringBoot-Staters和自定义Starter》官方文档翻译的〔案例〕篇：手把手完成自定义Starter(日志+参数)。

环境	版本
java jdk	1.8.0_191
dea	2018.3
maven	3.6.3
spring boot	2.2.2.RELEASE

项目运行结果截图

在这里插入图片描述

Just do it !

Part 1：自定义Starter
- 新建 maven 工程
- 实现自定义配置功能
- 添加 pom 依赖
- 实现注解开发日志功能
- 添加自动配置
- 添加 META-INF 自动配置的注册
- 打包安装到本地 maven 仓库
Part 2：新建测试工程
- 新建测试工程
- 引入自定义Starter
- 添加测试代码
- 测试功能

Let`s Go !

Part 1：自定义Starter

新建 maven 工程

新建空的maven项目
注意项目名称
修改项目结构，删除无用目录和文件，添加如图示的文件。

修改项目结构

添加 pom 依赖

<?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>site.okliu</groupId>
  <artifactId>mylog-spring-boot-starter</artifactId>
  <version>1.1-SNAPSHOT</version>

  <name>mylog-spring-boot-starter</name>
  <url>http://okliu.site</url>
  <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>

  <dependencies>

    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter</artifactId>
      <version>2.2.2.RELEASE</version>
    </dependency>

    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-autoconfigure</artifactId>
      <version>2.2.2.RELEASE</version>
    </dependency>

    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-configuration-processor</artifactId>
      <version>2.2.2.RELEASE</version>
      <optional>true</optional>
    </dependency>

    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-web</artifactId>
      <version>2.2.2.RELEASE</version>
      <optional>true</optional>
    </dependency>

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

    <dependency>
      <groupId>com.alibaba</groupId>
      <artifactId>fastjson</artifactId>
      <version>1.2.62</version>
      <optional>true</optional>
    </dependency>

  </dependencies>

</project>

实现自定义配置功能

MyLogProperties

package site.okliu.mylog.properties;

import lombok.Getter;
import lombok.Setter;
import org.springframework.boot.context.properties.ConfigurationProperties;

@Getter
@Setter
// prefix 后面在spring.properties中使用时的前缀名称
@ConfigurationProperties(prefix = "okliu.mylog")
public class MyLogProperties {

    // 日志标记前缀
    private String prefix;

}

实现注解开发日志功能

-MyLogInterceptor拦截器

package site.okliu.mylog.interceptor;

import com.alibaba.fastjson.JSON;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.method.HandlerMethod;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import site.okliu.mylog.annotation.MyLog;
import site.okliu.mylog.properties.MyLogProperties;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.lang.reflect.Method;
// 声明原作者代码引自：https://www.cnblogs.com/cjsblog/p/10926408.html
// 加入了自定义配置myLogProperties，以及BUG修复 if (handler instanceof HandlerMethod)
@Slf4j
public class MyLogInterceptor implements HandlerInterceptor {

    private static final ThreadLocal<Long> startTimeThreadLocal = new ThreadLocal<>();

    private MyLogProperties myLogProperties;

    public MyLogInterceptor(MyLogProperties myLogProperties) {
        this.myLogProperties = myLogProperties;
    }

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        if (handler instanceof HandlerMethod) {
            HandlerMethod handlerMethod = (HandlerMethod) handler;
            Method method = handlerMethod.getMethod();
            MyLog myLog = method.getAnnotation(MyLog.class);
            if (null != myLog) {
                long startTime = System.currentTimeMillis();
                startTimeThreadLocal.set(startTime);
            }
        }
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        if (handler instanceof HandlerMethod) {
            HandlerMethod handlerMethod = (HandlerMethod) handler;
            Method method = handlerMethod.getMethod();
            MyLog myLog = method.getAnnotation(MyLog.class);
            if (null != myLog) {
                // 获取开始时间
                long startTime = startTimeThreadLocal.get();
                long endTime = System.currentTimeMillis();
                long expendTime = endTime - startTime;
                // 打印参数
                String requestUri = request.getRequestURI();
                String methodName = method.getDeclaringClass().getName() + "#" + method.getName();
                String methodDesc = myLog.desc();
                String parameters = JSON.toJSONString(request.getParameterMap());
                String prefix = myLogProperties.getPrefix() == null ? "" : myLogProperties.getPrefix()+"-";
                log.info("\n描述：{}{}\n路径: {}\n方法: {}\n参数：{}\n耗时：{}\n", prefix,methodDesc, requestUri, methodName, parameters, expendTime);
            }
        }
    }
}

MyLog自定义注解

package site.okliu.mylog.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
// 声明原作者代码引自：https://www.cnblogs.com/cjsblog/p/10926408.html
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface MyLog {

    /**
     * 方法描述
     */
    String desc() default "";

}

添加自动配置

MyLogAutoConfiguration注册拦截器

package site.okliu.mylog.config;


import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
import site.okliu.mylog.interceptor.MyLogInterceptor;
import site.okliu.mylog.properties.MyLogProperties;

// 声明原作者代码引自：https://www.cnblogs.com/cjsblog/p/10926408.html
// 新增一处，修改一处

// 此时是注册自定义配置，会在项目启动时，自动创建MyLogProperties对象
@EnableConfigurationProperties(MyLogProperties.class)
// 此处注解是标明当前是配置类
@Configuration
public class MyLogAutoConfiguration implements WebMvcConfigurer {// 由于需要注册本例中的拦截器，此时实现接口

	// 新增
    @Autowired
    private MyLogProperties myLogProperties;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
    	// 此处需要在拦截器创建时传入自定义配置的对象，不然在拦截器中无法使用配置的属性
        registry.addInterceptor(new MyLogInterceptor(myLogProperties));
    }

}

添加 META-INF 自动配置的注册

在 spring.factories 添加如下代码进行自动化注册，注意 = 后面的 ****（斜杠）

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
  site.okliu.mylog.config.MyLogAutoConfiguration

打包安装到本地 maven 仓库

注意 IDEA 修改 install 命令，具体修改看图；eclipse 亲测正常。
双击运行
查看本地 maven 安装
至此，自定义starter的工作全部结束，下来就是测试和使用

Part 2：新建测试工程

新建 spring boot 工程

在这里插入图片描述

引入自定义Starter

删除无用部分项目结构，添加核心依赖，并配置自定义属性
完整的pom

<?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.2.2.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.example</groupId>
    <artifactId>test-mylog</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>test-mylog</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>

        <dependency>
            <groupId>site.okliu</groupId>
            <artifactId>mylog-spring-boot-starter</artifactId>
            <version>1.1-SNAPSHOT</version>
        </dependency>

    </dependencies>

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

</project>

添加测试代码

HelloController

package com.example.testmylog.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.ResponseBody;
import site.okliu.mylog.annotation.MyLog;

@Controller
@RequestMapping("/hello")
public class HelloController {

    @MyLog(desc = "打招呼 sayHello")
    @ResponseBody
    @RequestMapping("{name}")
    public String sayHello(@PathVariable  String name){
        String content = "say hello to " + name;
        return content;
    }

    @MyLog(desc = "打招呼 sayHi")
    @ResponseBody
    @RequestMapping("")
    public String sayHi(@RequestParam("name") String name){
        String content = "say hi to " + name;
        return content;
    }

}

测试功能

此时无法运行，原因是我们在自定义starter中配置的jar包，都属于可选的，所以到测试项目时，需要重新配置
解决办法，在测试案例的pom中可以引入和自定义starter一样的jar依赖
重新运行，测试正常
最终测试项目的pom文件

<?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.2.2.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.example</groupId>
    <artifactId>test-mylog</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>test-mylog</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>

        <dependency>
            <groupId>site.okliu</groupId>
            <artifactId>mylog-spring-boot-starter</artifactId>
            <version>1.1-SNAPSHOT</version>
        </dependency>

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

        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <version>1.2.62</version>
        </dependency>

    </dependencies>

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

</project>