自从用了spring boot，都忘记spring mvc中的xml配置是个什么东西了，再也回不去。为啥spring boot这么好用呢， 约定大于配置的设计初衷， 让我们只知道维护好application.properties(或application.yml)文件就可以了，我们在配置文件里可以设置数据源参数，可以设置服务端口，可以设置redis的地址等等。我们经常会看一些包含starter名字的jar包，如spring-boot-starter-data-redis，引入这些jar包，我们就可以简单快速配置了。那么我们自己开发了一个接口服务给别人调用，我们是不是可以把它封装成一个starter jar包呢？让别人在application.properties定义，实现自动配置呢？答案是允许的，下面跟我一起写一个自动配置jar包。（本文的目的不是讲解自动配置的原理，大家可以自行网上搜索原理）。
开发工具：idea
maven版本号：3.5.4
创建一个springboot项目
填写坐标信息
springboot版本2.0.4
其他默认，创建完成后，目录如下
接下来创建我们的测试服务类testservice
我要评论 1 package com.tanghuachun.teststarter;
2
3 public class testservice {
4
5 private string ip;
6 private int port;
7
8 public testservice(string ip, int port){
9 this.ip = ip;
10 this.port = port;
11 }
12
13 public void printconfinfo(){
14 system.out.println("骚年，你配置的ip为：" + ip + "，端口为：" + port);
15 }
16 }
我们设想，别人使用我们这个接口的时候，将ip和port通过application.properties注入，接下来我们创建属性配置实体类testserviceproperties
1 package com.tanghuachun.teststarter;
2
3 import org.springframework.boot.context.properties.configurationproperties;
4
5 @configurationproperties(prefix = "test-config")//取配置文件前缀为test-config配置
6 public class testserviceproperties {
7 private string host;
8 private int port;
9
10 public string gethost() {
11 return host;
12 }
13
14 public void sethost(string host) {
15 this.host = host;
16 }
17
18 public int getport() {
19 return port;
20 }
21
22 public void setport(int port) {
23 this.port = port;
24 }
25 }
我们发现在这个类写好后提示有错误
在pom文件加上依赖包，问题解决
<dependency>
<groupid>org.springframework.boot</groupid>
<artifactid>spring-boot-configuration-processor</artifactid>
<optional>true</optional>
</dependency>
新建一个自动配置类testserviceautoconfiguration
1 package com.tanghuachun.teststarter;
2
3 import org.springframework.boot.autoconfigure.condition.conditionalonclass;
4 import org.springframework.boot.autoconfigure.condition.conditionalonmissingbean;
5 import org.springframework.boot.autoconfigure.condition.conditionalonproperty;
6 import org.springframework.boot.context.properties.enableconfigurationproperties;
7 import org.springframework.context.annotation.bean;
8 import org.springframework.context.annotation.configuration;
9
10 @configuration
11 @conditionalonclass(testservice.class)// 存在testservice这个类才装配当前类
12 @conditionalonproperty(name = "test-config.enabled", havingvalue = "true", matchifmissing = true)//配置文件存在这个test-config.enabled=true才启动，允许不存在该配置
13 @enableconfigurationproperties(testserviceproperties.class)
14 public class testserviceautoconfiguration {
15 @bean
16 @conditionalonmissingbean // 没有testservice这个类才进行装配
17 public testservice testservice(testserviceproperties testserviceproperties) {
18 return new testservice(testserviceproperties.gethost(), testserviceproperties.getport());
19 }
20 }
相关注解含义在注释中已经说明,到这里，代码已经写好了，我们希望以注解的方式给用户使用，自定义一个注解@enabletestservice
1 package com.tanghuachun.teststarter;
2 import org.springframework.context.annotation.import;
3 import java.lang.annotation.*;
4
5 @inherited
6 @documented
7 @target(elementtype.type)
8 @retention(retentionpolicy.runtime)
9 @import(testserviceautoconfiguration.class)
10 //相当于使用定义spring.factories完成bean的自动装配
11 public @interface enabletestservice {
12 //@import(testserviceautoconfiguration.class) 需要在调用者的main 类加上该注解就能等效于spring.factories 文件配置
13 }
然后注释掉pom文件中的maven插件，如下图
然后maven打包，就会生成一个jar包，这个jar包我们就可以直接用了
这里因为在本地环境测试，我们将编译好的jar安装到本地maven仓库，点击右边的install按钮（你也可以导入编译好的jar包一样的）
我们开始来测试我们封装好的jar，首先创建一个springboot项目（创建时一路默认，你的包名也可以和我一样，无所谓的）
pom文件的依赖配置如下
<dependencies>
<dependency>
<groupid>org.springframework.boot</groupid>
<artifactid>spring-boot-starter-web</artifactid>
</dependency>
<dependency>
<groupid>com.tanghuachun</groupid>
<artifactid>test-starter</artifactid>
<version>0.0.1-snapshot</version>
</dependency>
<dependency>
<groupid>org.springframework.boot</groupid>
<artifactid>spring-boot-starter-test</artifactid>
<scope>test</scope>
</dependency>
</dependencies>
在main入口类加上注解
创建一个testcontroller类
1 package com.tanghuachun.testmain;
2
3 import com.tanghuachun.teststarter.testservice;
4 import org.springframework.beans.factory.annotation.autowired;
5 import org.springframework.web.bind.annotation.getmapping;
6 import org.springframework.web.bind.annotation.restcontroller;
7
8 @restcontroller
9 public class testcontroller {
10 @autowired
11 private testservice testservice;
12
13 @getmapping(value = "/test")
14 public string test(){
15 testservice.printconfinfo();
16 return "ok";
17 }
18 }
接下来在application.properties中配置参数
启动该项目，在地址栏输入 http://www.lhsxpumps.com/_localhost:8080/test 回车，看控制台打印的信息恰好是我们需要的
到这里我们就完成了一个自动配置的封装。
骚年们可以研究一下starter中注解@conditionalonproperty对使用的影响。
今天的故事讲完了。
如对本文有疑问， 点击进行留言回复！！
详解SpringBoot修改启动端口server.port的四种方式
网友评论