【讀官方文檔，學原味技術】SpringBoot-Staters和自定義Starter〔案例〕

spring-boot-reference

如果不想閱讀英文原文，你可以直接讀本文的【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 工程

修改項目結構，刪除無用目錄和文件，添加如圖示的文件。

添加 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>

THE END !
END !
!

如果覺得不錯，點個贊，分享下！

讀官方文檔，學原味技術！

【讀官方文檔，學原味技術】SpringBoot-Staters和自定義Starter〔案例〕

項目運行結果截圖

Just do it !

Part 1：自定義Starter

新建 maven 工程

添加 pom 依賴

實現自定義配置功能

實現註解開發日誌功能

添加自動配置

添加 META-INF 自動配置的註冊

打包安裝到本地 maven 倉庫

Part 2：新建測試工程

新建 spring boot 工程

引入自定義Starter

添加測試代碼

測試功能

如果覺得不錯，點個贊，分享下！

python gdal 安裝使用（Windows， python 3.6.8）

【讀官方文檔，學原味技術】SpringBoot-Staters和自定義Starter〔案例〕

修改ubuntu鏡像下載源

使用docker-compose安裝sonatype/nexus3、管理員密碼

使用GitLab和Git免密登錄設置【解決BUG】

安裝docker-compose

Mac下配置sublime實現LaTeX

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結

【讀官方文檔，學原味技術】SpringBoot-Staters和自定義Starter〔案例〕

項目運行結果截圖

Just do it !

Part 1：自定義Starter

新建 maven 工程

添加 pom 依賴

實現自定義配置功能

實現註解開發日誌功能

添加自動配置

添加 META-INF 自動配置的註冊

打包安裝到本地 maven 倉庫

Part 2：新建 測試工程

新建 spring boot 工程

引入自定義Starter

添加測試代碼

測試功能

如果覺得不錯，點個贊，分享下！

Part 2：新建測試工程