1.前言
Spring Boot内部定义了各种各样的xxxAutoConfiguration配置类,预先定义好了各种所需的Bean。只有在特定的情况下这些配置类才会被起。 那我们如何定义一个自己的Configuration呢?顺便了解一下原理?
2.那我们开始吧,哈哈哈
2.1 新建一个Maven工程
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-hello</artifactId>
<version>1.0-SNAPSHOT</version>
2.2 修改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>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-hello</artifactId>
<version>1.0-SNAPSHOT</version>
<packaging>jar</packaging>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<java.version>1.8</java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-autoconfigure</artifactId>
<version>1.4.3.RELEASE</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
<version>1.4.3.RELEASE</version>
<optional>true</optional>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
2.3 创建HelloServiceProperties类,自动属性配置类
package com.cxx.springboot.starter.hello;
import org.springframework.boot.context.properties.ConfigurationProperties;
/**
* User: lanxinghua
* Date: 2018/10/7 21:36
* Desc: hello 自动配置属性类
*/
@ConfigurationProperties(prefix = "hello")
public class HelloServiceProperties {
private static final String MSG = "world";
private String msg = MSG;
public String getMsg() {
return msg;
}
public void setMsg(String msg) {
this.msg = msg;
}
}
2.4 创建HelloService,服务类
package com.cxx.springboot.starter.hello;
/**
* User: lanxinghua
* Date: 2018/10/7 21:38
* Desc: 服务类
*/
public class HelloService {
private String msg;
public String getMsg() {
return msg;
}
public void setMsg(String msg) {
this.msg = msg;
}
public String sayHello(){
return "hello" + msg;
}
}
2.5 创建HelloServiceAutoConfiguration,自动配置类
package com.cxx.springboot.starter.hello;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
/**
* User: lanxinghua
* Date: 2018/10/7 21:40
* Desc: 自动配置类
*/
@Configuration
@EnableConfigurationProperties(HelloServiceProperties.class)
@ConditionalOnClass(HelloService.class) //判断该类在类路径下是否存在
@ConditionalOnProperty(prefix = "hello", value = "ebabled", matchIfMissing = true)
public class HelloServiceAutoConfiguration {
@Autowired
private HelloServiceProperties helloServiceProperties;
@Bean
@ConditionalOnMissingBean(HelloService.class)
public HelloService helloService(){
HelloService helloService = new HelloService();
helloService.setMsg(helloServiceProperties.getMsg());
return helloService;
}
}
2.6 注册配置
1、在src/main/resources新建META-INF文件夹
2、在META-INF文件夹下新建spring.factories文件
3、注册配置自动配置类
spring.factories
org.springframework.boot.autoconfigure.EnableAutoConfiguration=
com.cxx.springboot.starter.hello.HelloServiceAutoConfiguration
2.7 将上面构建的starter安装到本地
mvn clean install
3.使用自定义的Configuration
新建一个springboot项目,添加依赖
测试一下:
package com.example;
import com.cxx.springboot.starter.hello.HelloService;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import javax.annotation.Resource;
@RestController
@SpringBootApplication
public class DesignsApplication {
@Resource
private HelloService helloService;
@RequestMapping("/test")
public String test(){
return helloService.sayHello();
}
public static void main(String[] args) {
SpringApplication.run(DesignsApplication.class, args);
}
}