封装自己的SDK

喜欢ヅ旅行 2024-03-31 14:39 78阅读 0赞

## 封装自己的SDK ##

我们在开发Spring项目时常常会引入各种`xxx-spring-boot-starter`的依赖包，然后在配置文件中填入必要的信息，就可以使用依赖提供好的容器。这里是在鱼皮新项目直播中学习到的，特此记录一下。可在未来封装自己的SDK进行封装与装逼。

## SDK项目下 ##

1.  ### 将pom.xml中的标签删除 ###

<build>
           <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                    <configuration>
                        <excludes>
                            <exclude>
                                <groupId>org.projectlombok</groupId>
                                <artifactId>lombok</artifactId>
                            </exclude>
                        </excludes>
                    </configuration>
                </plugin>
            </plugins>
    </build>

### 2.定义我们需要的模型 ###

@Data
    @AllArgsConstructor
    @Slf4j
    public class sqlSessionFactory {
        private String userName;
        private String password;
        private String driver;
        private String url;
    
        /**
         * 获取连接
         */
        public Connection getConnection() {
            log.info("创建并返回数据库Connection");
            return null;
        }
    }

### 3.自动扫描并添加容器 ###

@Configuration
    @ConfigurationProperties("sicheng.database")
    @Data
    @ComponentScan
    public class  sqlSessionConfig{
        private String userName;
        private String password;
        private String driver;
        private String url;
    
        @Bean
        public sqlSessionFactory getSqlSessionFactory() {
            return new sqlSessionFactory(userName,password,driver,url);
        }
    }

### 4.在resources资源下进行配置：META-INF包下的spring.factories文件 ###

>     # spring boot starter  这里配置你注册容器类的引用，也就是第三步的类引用，会自动扫描并注入
>     org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.example.sichengclientsdk.sqlSessionConfig

### 5.Maven进行install操作，在你的pom.xml中找到对应的依赖值 ###

<groupId>com.sicheng</groupId>
    <artifactId>sicheng-client-sdk</artifactId>
    <version>0.0.1</version>

### 7.在别的项目中进行引用，这里需要注意：maven的install只会创建在本地，如果远程使用，需要注册到Maven依赖库 ###

## 需要依赖的项目 ##

1.  ### 依赖引入 ###

<dependency>
                <groupId>com.sicheng</groupId>
                <artifactId>sicheng-client-sdk</artifactId>
                <version>0.0.1</version>
    </dependency>

### 2.在Resource中填入需要的值，这里注意我们需要在SDK环境中引入`spring-boot-configuration-processor`,这样当我们使用依赖后，可在`application.yml`中看到提示 ###

<dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-configuration-processor</artifactId>
        <optional>true</optional>
    </dependency>

sicheng:
      database:
        driver: com.mysql.cj.jdbc.Driver
        url: jdbc:mysql://localhost:3306/sicheng
        username: root
        password: 123456

### 4.自动注入容器并使用 ###

@Resource
    sqlSessionConfig sqlSessionConfig;
    
    @Test
    void testMySDK() {
        sqlSessionFactory factory = sqlSessionConfig.getSqlSessionFactory();
        factory.getConnection();
        // 输出：创建并返回数据库Connection
        // 输出：sqlSessionFactory(userName=root, password=123456, driver=com.mysql.cj.jdbc.Driver, url=jdbc:mysql://localhost:3306/sicheng)
        System.out.println(factory);
    }