自定义Stater

最新推荐文章于 2024-10-06 08:43:20 发布

凌晨去看海

最新推荐文章于 2024-10-06 08:43:20 发布

阅读量779

点赞数 21

文章标签： spring boot spring java

本文链接：https://blog.csdn.net/m0_63624484/article/details/141993785

版权

一什么是stater？

我们平时在导入依赖的时候，大部分导入的都是xxx-spring-boot-stater。那是因为它们都基于spring的规则将写好的框架定义成一个stater，这样方便springboot引用它们写好的功能。

那我们为什么也要自定义stater呢？我们在做一个完整项目的时候，通常需要很多功能，而我们可以把一些通用的功能脱离出来，把它单独定义成一个stater放到我们的本地仓库，而我们哪个项目需要用到这个功能，就可以直接在pom文件中导入这个stater的依赖，这样就可以使用这里面的功能了，所以这大大提高代码复用性，同时对代码进行了解耦合。

二如何自定义stater？

1.创建一个Maven项目，并且在pom文件中导入以下依赖

因为stater本身也是一个功能模块，我们要在里面写我们的功能。

<?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.fs</groupId>
    <artifactId>hello-spring-boot-starter</artifactId>
    <version>1.0-SNAPSHOT</version>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.3.12.RELEASE</version>
        <relativePath/>
    </parent>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-autoconfigure</artifactId>
        </dependency>
         <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <optional>true</optional>
        </dependency>
    </dependencies>
</project>

2.创建配置属性类xxxProperties

因为我们需要在这个stater事项某个功能模块，而你实现一个功能肯定不是硬编码，你需要什么参数肯定是使用者那需求传给你的，所以这个类就是用来定义需要的参数属性的类，这里给一个代码示例：
package com.fs.hello.config;

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

@ConfigurationProperties("fs.hello")
public class HelloProperties {
    private String name;
    private String msg;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getMsg() {
        return msg;
    }

    public void setMsg(String msg) {
        this.msg = msg;
    }

    @Override
    public String toString() {
        return "HelloProperties{" +
                "name='" + name + '\'' +
                ", msg='" + msg + '\'' +
                '}';
    }
}
这里需要注意几个点，第一个就是每个属性必须要有get，set方法。

另外一个就是类上面的@ConfigurationProperties("fs.hello")这个注解，它是表明这个类是一个属性配置类，而参数fs.hello就是你导入它的依赖后，想要给他配置属性，在yml文件中，就是使用

fs

hello

name: "zhangsan"

这样配置的。

3.创建服务类xxxService

属性类有了，那么就该实现具体功能了，所以你需要在service包下创建一个服务类，专门来实现你这个stater的功能，这里给一个代码示例：
package com.fs.hello.service;

public class HelloService {
    private String name;
    private String msg;

    public HelloService(String name, String msg) {
        this.name = name;
        this.msg = msg;
    }

    public String sayHello(){
        return "你好！我的名字叫 " + name + "，信息: " + msg;
    }

}
他的功能很简单，就是实现了一个sayHello的功能，然后你看它的构造方法，new这个对象需要传入两个参数，而这个两个参数就是我们上面配置属性内的属性。

4.创建自动配置类xxxAutoConfiguration

这是一个stater中的核心类，我把它的功能解释为：告诉spring它是一个配置类，开启配置属性类，将功能类交给容器管理。它是上面两个类的枢纽。

package com.fs.hello.config;

import com.fs.hello.service.HelloService;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * HelloService的自动配置类
 */
@Configuration
@EnableConfigurationProperties(HelloProperties.class)
public class HelloServiceAutoConfiguration {
    private HelloProperties helloProperties;

    //通过构造方法注入配置属性对象HelloProperties
    public HelloServiceAutoConfiguration(HelloProperties helloProperties) {
        this.helloProperties = helloProperties;
    }
    //实例化HelloService并载入Spring IoC容器
    @Bean
    @ConditionalOnMissingBean
    public HelloService helloService(){
        return new HelloService(helloProperties.getName(),helloProperties.getMsg());
    }

}

5.在resources目录下创建META-INF/spring.factories

刚刚我们说到，所有的外部stater都是按照spring的约定来定义的，那么这就需要知道spring自动配置的原理了。

我们需要使用那个stater只需要导入它的依赖，而spring虽然有了你的依赖，但是它需要实例化stater的类，可是实例化只能通过反射，但是反射需要知道类的全限定命，而spring怎么知道你这个类的全限定名呢？每个人的包的名字都是不一样的，所以spring就从MATE-INF目录下面找到一个叫做spring.factories的文件，然后里面记录的就是所有Bean的全限定名，这样他就可以实例化这个Bean了。

所以我们必须要按照spring的规定来，所以我们也需要在这个目录下创建这个文件，并且在这个文件里面配置上我们刚刚的自动配置类的全限定名路径。
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.fs.hello.config.HelloServiceAutoConfiguration
以=\作为区分，前面部分是固定写法，就像key-value一样，spring通过扫描前面的key得到后面的value，而后面就是你的自动配置类的全限定名了。