自定义基于springboot的starter

1. 我们先创建一个 Starter，名字叫myjson-spring-boot-starter，并加入自动装配和 fastjson 的依赖，如下

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-autoconfigure</artifactId>
    <version>2.2.6.RELEASE</version>
</dependency>

 

1. 然后我们创建一个 Service，并增加一个public String objToJson(Object object)方法，直接调用fastjson 的方法

import com.alibaba.fastjson.JSON;

public class MyJsonService {

 private String name;
 /**
 * 使用 fastjson 将对象转换为 json 字符串输出
 * @param object 传入的对象
 * @return 输出的字符串
 */
 public String objToJson(Object object) {
     return getName() + JSON.toJSONString(object);
 }
 public String getName() {
     return name;
 }
 public void setName(String name) {
     this.name = name;
 }
}

1. 编写配置类

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

@ConfigurationProperties(prefix = "ziyou.json")
public class MyJsonProperties {
 public static final String DEFAULT_NAME = "ziyou";
 private String name = DEFAULT_NAME;
 public String getName() {
     return name;
 }
 public void setName(String name) {
     this.name = name;
 }
}

1. 创建自动化配置类

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.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
@ConditionalOnClass({MyJsonService.class})
@EnableConfigurationProperties(MyJsonProperties.class)
public class MyJsonAutoConfiguration {
 /**
 * 注入属性类
 */
 @Autowired
 private MyJsonProperties myJsonProperties;
 /**
 * 当当前上下文中没有 MyJsonService 类时创建类
 *
 * @return 返回创建的实例
 */
 @Bean
 @ConditionalOnMissingBean(MyJsonService.class)
 public MyJsonService myJsonService() {
 MyJsonService myJsonService = new MyJsonService();
 myJsonService.setName(myJsonProperties.getName());
 return myJsonService;
 }
}

1. 然后我们再创建 resource/META-INF/spring.factories 文件，增加如下内容，将自动装配的类配置上

org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.ziyou.starter.MyJsonAutoConfiguration

 

1. 然后我们通过运行mvn install命令，将这个项目打包成 jar 部署到本地仓库中，提供让另一个服务调用。
2. 创建一个新的 SpringBoot web 项目test-myjson-spring-boot-starter，提供一个接口去访问。

package com.ziyou.test.controller;
import com.ziyou.starter.MyJsonService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class MyJsonController {

 @Autowired
 private MyJsonService myJsonService;

 @RequestMapping(value = "tojson")
 public String getStr() {
     User user = new User();
     user.setName("dsfsf");
     user.setAge(18);
     return myJsonService.objToJson(user);
 }
}

1. application.properties 中配置。

server.port=8089
ziyou.json.name=java-geek-teck

 

1. pom.xml 中配置刚刚编写的 Starter。

<?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.ziyou</groupId>
 <artifactId>test-myjson-spring-boot-starter</artifactId>
 <version>1.0-SNAPSHOT</version>

 <dependencies>

     <dependency>
         <groupId>com.ziyou</groupId>
         <artifactId>myjson-spring-boot-starter</artifactId>
         <version>1.0-SNAPSHOT</version>
     </dependency>

     <dependency>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-starter-web</artifactId>
     </dependency>

     <dependency>
           <groupId>org.springframework.boot</groupId>
           <artifactId>spring-boot-starter</artifactId>
     </dependency>

 </dependencies>
</project>

1. 启动测试项目，打开浏览器访问接口可以看到如下效果。

 

1. 分析：从结果中我们可以看到在 Starter 中定义的MyJsonService已经被成功的调用和执行。