Spring Boot 自动化配置之自定义一个Starter

Posted 2023-03-20

大家好，我是小悟

Spring Boot官网各类启动器：

​​https://docs.spring.io/spring-boot/docs/current/reference/html/using-boot-build-systems.html#using-boot-starter​​

Spring Boot将所有的功能场景都抽取出来，做成一个个starter，只需要在项目里面引入这些starter，相关的依赖包都会导入进来，可以说是十分的方便了。在日常的开发中，我们也可以结合业务自定义需要的starter，供其他开发小伙伴调用。

1、创建一个新的空工程

2、创建两个module，austin-spring-boot-starter启动器是普通的maven工程，austin-spring-boot-starter-autoconfigurer自动配置模块是普通的springboot工程

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

<groupId>com.austin.starter</groupId>
<artifactId>austin-spring-boot-starter</artifactId>
<version>1.0-SNAPSHOT</version>

<!--启动器-->
<dependencies>

    <!--引入自动配置模块-->
    <dependency>
        <groupId>com.austin.starter</groupId>
        <artifactId>austin-spring-boot-starter-autoconfigurer</artifactId>
        <version>0.0.1-SNAPSHOT</version>
    </dependency>
</dependencies>

</project>

austin-spring-boot-starter-autoconfigurer的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>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.6.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.austin.starter</groupId>
    <artifactId>austin-spring-boot-starter-autoconfigurer</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>austin-spring-boot-starter-autoconfigurer</name>
    <description>Demo project for Spring Boot</description>

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

    <dependencies>
        <!--引入spring‐boot‐starter；所有starter的基本配置-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>

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

    </dependencies>

</project>

3、在austin-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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.austin.starter</groupId>
    <artifactId>austin-spring-boot-starter</artifactId>
    <version>1.0-SNAPSHOT</version>

    <!--启动器-->
    <dependencies>

        <!--引入自动配置模块-->
        <dependency>
            <groupId>com.austin.starter</groupId>
            <artifactId>austin-spring-boot-starter-autoconfigurer</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </dependency>
    </dependencies>

</project>

4、在austin-spring-boot-starter-autoconfigurer下新建HelloProperties、HelloService、HelloServiceAutoConfiguration

package com.austin.starter;

import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;

/**
 * @ClassName HelloProperties
 * @Description
 */
@ConfigurationProperties(prefix = "austin.hello")
@Data
public class HelloProperties 

    private String prefix;
    private String suffix;

package com.austin.starter;

import lombok.Data;

/**
 * @ClassName HelloService
 * @Description
 */
@Data
public class HelloService 

    HelloProperties helloProperties;

    public String sayHello(String name)
        return helloProperties.getPrefix() + "-" + name + "-" + helloProperties.getSuffix();
    

package com.austin.starter;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * @ClassName HelloServiceAutoConfiguration
 * @Description
 */
@Configuration
@ConditionalOnWebApplication//web应用才生效
@EnableConfigurationProperties(HelloProperties.class)//让配置属性文件生效
public class HelloServiceAutoConfiguration 

    @Autowired
    HelloProperties helloProperties;

    @Bean
    public HelloService helloService()
        HelloService service = new HelloService();
        service.setHelloProperties(helloProperties);
        return service;
    

5、resources下面新建META-INF-spring.factories文件

内容如下

# Auto Configure
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\\
com.austin.starter.HelloServiceAutoConfiguration 

因为starter是依赖autoconfigurer的，所以先把autoconfigurer安装到本地仓库，再安装starter

6、另外新建一个springboot工程来测试我们自定义的starter

7、新建一个controller来测试

package com.austin.custom.controller;

import com.austin.starter.HelloService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @ClassName HelloController
 * @Description
 */
@RestController
public class HelloController 

    @Autowired
    HelloService helloService;

    @GetMapping(value = "/sayHello")
    public String sayHello() 
        return helloService.sayHello("你好");
    

在application.yml中传入我们在austin-spring-boot-starter-autoconfigurer定义的两个参数prefix和suffix

8、启动springboot测试

您的一键三连，是我更新的最大动力，谢谢

山水有相逢，来日皆可期，谢谢阅读，我们再会

我手中的金箍棒，上能通天，下能探海

spring boot整合 spring security之自定义退出

一 security默认的退出

Spring security 默认实现了 logout 退出，访问 /logout：

 实现逻辑：

点击 “Log Out” 退出 成功。

退出 后访问其它 url 判断是否成功退出。

二 自定义退出

2.1 配置文件中配置

在 WebSecurityConfifig 的 protected void confifigure(HttpSecurity http) 中配置：

.and() .logout() .logoutUrl("/logout") .logoutSuccessUrl("/login‐view?logout");

 2.2 测试

 

 

输入退出地址：

 

 

退出之后，跳转到session失效的url制定的页面

 

将session失效的跳转路径注释掉：

 重新登录访问，退出测试：

 

 

 退出到登录界面：

可以看到：如果设置了session失效跳转路径，退出登录后，还要执行session失效跳转的路径。 

当退出操作出发时，将发生：

使HTTP Session 无效

清除 SecurityContextHolder

跳转到 /login-view?logout

如果设置了session失效路径，则跳转到session失效的路径 。

 2.3 自定退出的更丰富功能

@Override

protected void configure ( HttpSecurity http ) throws Exception {

http

. authorizeRequests ()

//...

. and ()

. logout () ( 1 )

. logoutUrl ( "/logout" ) ( 2 )

. logoutSuccessUrl ( "/login‐view?logout" ) ( 3 )

. logoutSuccessHandler ( logoutSuccessHandler ) ( 4 )

. addLogoutHandler ( logoutHandler ) ( 5 )

. invalidateHttpSession ( true ); ( 6 )

}

（ 1 ）提供系统退出支持， 使用 WebSecurityConfigurerAdapter 会自动被应用

（ 2 ）设置触发退出操作的URL (默认是 /logout ).

（ 3 ）退出之后跳转的 URL。默认是 /login?logout 。

（ 4 ） 定制的 LogoutSuccessHandler ，用于实现用户退出成功时的处理。如果指定了这个选项那么 logoutSuccessUrl() 的设置会被忽略。

（ 5 ） 添加一个 LogoutHandler ，用于实现用户退出时的清理工作.默认 SecurityContextLogoutHandler 会被添加 为最后一个 LogoutHandler 。

（ 6 ）指定是否在退 出时让 HttpSession 无效。 默认设置为 true。

注意：如果让 logout 在 GET 请求下生效，必须关闭防止 CSRF 攻击 csrf().disable() 。如果开启了 CSRF ，必须使用 post 方式请求 /logout

logoutHandler ：

一般来说， LogoutHandler 的实现类被用来执行必要的清理，因而他们不应该抛出异常。

下面是 Spring Security 提供的一些实现：

PersistentTokenBasedRememberMeServices 基于持久化token的RememberMe功能的相关清理

TokenBasedRememberMeService 基于token的RememberMe功能的相关清理

CookieClearingLogoutHandler 退出时Cookie的相关清理

CsrfLogoutHandler 负 责在退出时移除csrfToken

SecurityContextLogoutHandler 退出时SecurityContext的相关清理