手把手创建Springboot的Starter

最新推荐文章于 2024-08-27 23:56:02 发布

HunterQiuQiu

最新推荐文章于 2024-08-27 23:56:02 发布

阅读量456

点赞数

分类专栏： Java实践文章标签： spring java

本文链接：https://blog.csdn.net/Hunter_Sense/article/details/118686718

版权

Java实践专栏收录该内容

9 篇文章 0 订阅

订阅专栏

本文介绍了如何构建一个Spring Boot Starter，包括新建Maven工程、定义接口和实现、配置类以及在Spring的META-INF/spring.factories文件中声明配置。完成后，使用者只需引入依赖即可直接使用模块接口。示例展示了在Web工程中引入Starter并创建Controller调用接口的方法，实现了便捷的代码复用。

摘要由CSDN通过智能技术生成

1. Starter的构建

第一步：新建Maven工程，pom文件引入Springboot的依赖包

<?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.springstudy</groupId>
    <artifactId>study-client-starter</artifactId>
    <version>1.0-SNAPSHOT</version>

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

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-dependencies</artifactId>
                <version>2.3.1.RELEASE</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>


</project>

第二步：定义一个接口和简单的实现

package com.spring.study.module.impl;

import com.spring.study.module.HelloService;
import org.springframework.stereotype.Component;

/**
 * @author HunterQiu
 * @version 1.0
 * @date 2021/06/09 0:21
 * @description
 */

@Component
public class HelloServiceImpl implements HelloService {
    public String sayHello() {
        return "Hello Yihang";
    }
}

第三步：新建一个配置类，逻辑实现可以为空，重要的是注解

package com.spring.study.config;

import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;

/**
 * @author HunterQiu
 * @version 1.0
 * @date 2021/06/09 0:23
 * @description
 */
@Configuration
@ComponentScan({"com.spring.study.module"})
public class HelloServiceAutoConfiguration {
}

第四步：在Spring的根目录，也就是resources目录下建立META-INF/spring.factories文件，并声明配置文件的路径

spring.factories

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\ 
com.spring.study.config.HelloServiceAutoConfiguration

至此，一个标准的Starter开发完成。

2. Starter的使用

2.1 在你的Web工程pom里面，加入starter的依赖

<dependency>
    <groupId>com.springstudy</groupId>
    <artifactId>study-client-starter</artifactId>
    <version>1.0-SNAPSHOT</version>
</dependency>

2.2 新建一个controller，将模块的逻辑引入，如下所示

package gdufs.edu.com.controller;

import com.spring.study.module.HelloService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @author HunterQiu
 * @version 1.0
 * @date 2021/06/08 23:27
 * @description
 */

@RestController
public class TestController {

    @Autowired
    private HelloService helloService;

    @RequestMapping("/")
    public String home(){
       return helloService.sayHello();
    }
}

你会发现，刚才开发的Starter对于使用者来说非常方便，除了在pom中引入依赖，什么都不做就可以直接使用模块内部的接口注入。

本地IDEA启动Springboot，到浏览器上提交请求，可见结果成功返回。