手写一个springboot starter组件

前言

本文举例：手写一个redisson的springboot starter组件

目录

1.新建一个maven工程，编写redisson组件

1.2 pom文件，引入redisson包依赖

1.3 创建RedissonPropertites属性配置类

1.4 创建RedissonAutoConfiguretion 配置类

1.5 在META-INF目录下创建spring.factories文件

1.6 在META-INF下创建additional-spring-configuration-metadata.json文件，作用是在properties文件中弹出提示(可以不做)

1.7 以上步骤完成后，编译打包

2 新建一个springboot 工程，使用该组件

2.1 pom文件，引入starter组件组件依赖

2.2 编写application.properties redisson配置信息

2.3 新建测试TestController

2.4 启动项目

2.5 测试

---

1.新建一个maven工程，编写redisson组件

1.2 pom文件，引入redisson包依赖

---

<?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.liao.redis.example</groupId>
    <artifactId>myredisson-spring-boot-stater</artifactId>
    <version>1.0-SNAPSHOT</version>

    <dependencies>
        <dependency>
            <groupId>org.redisson</groupId>
            <artifactId>redisson</artifactId>
            <version>3.12.5</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
            <version>2.7.3</version>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.24</version>
        </dependency>
    </dependencies>


</project>

1.3 创建RedissonPropertites属性配置类
 

package com.liao.redis.example.config;

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

@ConfigurationProperties(prefix = "myredisson")
@Data
public class RedissonPropertites {

    private String host="localhost";

    private int port =  6379;

    private int timeout = 3000;

}

1.4 创建RedissonAutoConfiguretion 配置类

package com.liao.redis.example.config;

import org.redisson.Redisson;
import org.redisson.api.RedissonClient;
import org.redisson.config.Config;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@ConditionalOnClass(Redisson.class)
@Configuration
@EnableConfigurationProperties(RedissonPropertites.class)
public class RedissonAutoConfiguretion {


    @Bean
    public RedissonClient createRedissonClient(RedissonPropertites redissonPropertites){

        Config config = new Config();

        String prefix = "redis://";

        String host = redissonPropertites.getHost();

        int port = redissonPropertites.getPort();

        int timeout = redissonPropertites.getTimeout();

        config.useSingleServer()
                .setAddress(prefix+host+":"+port).
                setConnectTimeout(timeout);

        return Redisson.create(config);
    }

}

1.5 在META-INF目录下创建spring.factories文件

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
  com.liao.redis.example.config.RedissonAutoConfiguretion

1.6 在META-INF下创建additional-spring-configuration-metadata.json文件，作用是在properties文件中弹出提示(可以不做)

{
  "properties": [
    {
      "name": "myredisson.host",
      "type": "java.lang.String",
      "description": "redis服务器地址",
      "defaultValue": "localhost",
      "sourceType": "com.liao.redis.example.config.RedissonPropertites"
    },
    {
      "name": "myredisson.port",
      "type": "java.lang.Integer",
      "description": "redis服务器端口",
      "defaultValue": 6379,
      "sourceType": "com.liao.redis.example.config.RedissonPropertites"
    },
    {
      "name": "myredisson.timeout",
      "type": "java.lang.Integer",
      "description": "redis连接超时时间",
      "defaultValue": 3000,
      "sourceType": "com.liao.redis.example.config.RedissonPropertites"
    }
  ]
}

1.7 以上步骤完成后，编译打包

2 新建一个springboot 工程，使用该组件

2.1 pom文件，引入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>



  <groupId>com.liao.example</groupId>
  <artifactId>spring-boot-demo</artifactId>
  <version>1.0-SNAPSHOT</version>

  <name>spring-boot-demo</name>
  <!-- FIXME change it to the project's website -->
  <url>http://www.example.com</url>

  <properties>
    <java.version>1.8</java.version>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
    <spring-boot.version>2.3.0.RELEASE</spring-boot.version>
  </properties>

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


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

      <dependency>
          <groupId>com.liao.redis.example</groupId>
          <artifactId>myredisson-spring-boot-stater</artifactId>
          <version>1.0-SNAPSHOT</version>
      </dependency>

  </dependencies>

  <dependencyManagement>
    <dependencies>
      <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-dependencies</artifactId>
        <version>${spring-boot.version}</version>
        <type>pom</type>
        <scope>import</scope>
      </dependency>
    </dependencies>
  </dependencyManagement>

  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-compiler-plugin</artifactId>
        <configuration>
          <source>1.8</source>
          <target>1.8</target>
          <encoding>UTF-8</encoding>
        </configuration>
      </plugin>
      <plugin>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-maven-plugin</artifactId>
      </plugin>
    </plugins>
  </build>

</project>

2.2 编写application.properties redisson配置信息

myredisson.host=localhost
myredisson.port=6379
myredisson.timeout=2000

2.3 新建测试TestController

package com.liao.example;

import org.redisson.api.RBucket;
import org.redisson.api.RedissonClient;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class TestController {

    @Autowired
    RedissonClient redissonClient;

    @GetMapping("/redis/get")
    public Object get(@RequestParam("key")String key){
        RBucket<Object> bucket = redissonClient.getBucket(key);
        if(null == bucket.get() || "".equals(bucket.get())){
            bucket.set("hello nihao ");
        }
        return bucket.get();
    }

}

2.4 启动项目

package com.liao.example;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

/**
 * Hello world!
 *
 */
@SpringBootApplication
public class App {
    public static void main( String[] args )
    {
        SpringApplication.run(App.class,args);
    }
}

2.5 测试