你还不会手写SpringBoot启动器吗

最新推荐文章于 2024-05-14 15:51:44 发布
最新推荐文章于 2024-05-14 15:51:44 发布
阅读量198 收藏
点赞数
分类专栏： Spring 文章标签： spring spring boot java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/see__you__again/article/details/115701636
版权

Starter是什么 ？

Spring Boot 对比 Spring MVC 最大的优点就是使用简单，约定大于配置。不用 Spring MVC 的时候，时不时被 xml 配置文件搞的晕头转向，冷不防还因为 xml 配置上的一点疏忽，导致整个项目莫名其妙的不可用，顿感生无可恋。这要归功于Spring Boot 的各种各样的 starters，有官方提供以及第三方开源出来的。这些依赖模块都遵循着约定成俗的默认配置，并允许我们根据自身情况调整这些配置。基本上你打算用的功能都可以找到，如果没有找到，那就请再找一找。SpringBoot 会自动扫描需要加载的信息并启动相应的默认配置。

Starter 提供了以下功能：

  • 整合了模块需要的所有依赖，统一集合到 Starter 中。
  • 提供了默认配置，并允许我们调整这些默认配置。
  • 提供了自动配置类对模块内的 Bean 进行自动装配，注入 Spring 容器中。

Starter 命名规则

Spring 官方定义的 Starter 通常命名遵循的格式为 spring-boot-starter-{name}，例如 spring-boot-starter-data-mongodb。Spring 官方建议，非官方 Starter 命名应遵循 {name}-spring-boot-starter 的格式，例如，myjson-spring-boot-starter。

Starter可以用来解决什么问题？

日常开发中有一些独立于业务系统之外的配置模块，它是可以在不同项目中进行复用的。如果在每个项目中都编写重复的模块代码，除了浪费时间和人力耦合性还高。将这些可独立于业务代码之外的功能配置模块封装成一个 Starter，在需要用到此功能模块的项目中，只需要在其 pom.xml 文件中引用依赖即可。

手写SpringBoot启动器的主要步骤

  1. 定义业务接口、需要的实体类等业务对象
  2. 定义配置属性类、
  3. 定义自动装配类、
  4. Resources目录下新建META-INF/spring.factories，加入自定义starter的配置项
  1. idea——new  project——spring initializr——填写group、artifact名称，选择java的jdk版本——next ——next——finish

pom文件依赖

<?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 https://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.4.4</version>

        <relativePath/> <!-- lookup parent from repository -->

    </parent>

    <groupId>com.example</groupId>

    <artifactId>my-starter</artifactId>

    <version>0.0.1-SNAPSHOT</version>

    <name>my-starter</name>

    <description>Demo project for Spring Boot</description>

    <properties>

        <java.version>1.8</java.version>

    </properties>

    <dependencies>

        <dependency>

            <groupId>com.example</groupId>

            <artifactId>myjson-spring-boot-starter-autoconfigurer</artifactId>

            <version>0.0.1-SNAPSHOT</version>

        </dependency>

    </dependencies>

 

    <build>

        <plugins>

            <plugin>

                <groupId>org.springframework.boot</groupId>

                <artifactId>spring-boot-maven-plugin</artifactId>

            </plugin>

        </plugins>

    </build>

 

</project>

 

  1. 在当前工程创建module——name为myjson，流程同上

<?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 https://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.4.4</version>

        <relativePath/> <!-- lookup parent from repository -->

    </parent>

    <groupId>com.example</groupId>

    <artifactId>myjson-spring-boot-starter-autoconfigurer</artifactId>

    <version>0.0.1-SNAPSHOT</version>

    <name>myjson-spring-boot-starter-autoconfigurer</name>

    <description>Demo project for Spring Boot</description>

    <properties>

        <java.version>1.8</java.version>

    </properties>

    <dependencies>

        <dependency>

            <groupId>org.springframework.boot</groupId>

            <artifactId>spring-boot-starter</artifactId>

        </dependency>

        <dependency>

            <groupId>org.springframework.boot</groupId>

            <artifactId>spring-boot-configuration-processor</artifactId>

            <version>2.3.8.RELEASE</version>

            <optional>true</optional>

        </dependency>

        <dependency>

            <groupId>com.alibaba</groupId>

            <artifactId>fastjson</artifactId>

            <version>1.2.73</version>

        </dependency>

        <dependency>

            <groupId>org.springframework.boot</groupId>

            <artifactId>spring-boot-autoconfigure</artifactId>

            <version>2.3.8.RELEASE</version>

        </dependency>

        <dependency>

            <groupId>org.springframework.boot</groupId>

            <artifactId>spring-boot-starter-test</artifactId>

            <scope>test</scope>

        </dependency>

    </dependencies>

 

    <build>

        <plugins>

            <plugin>

                <groupId>org.springframework.boot</groupId>

                <artifactId>spring-boot-maven-plugin</artifactId>

                <configuration>

                    <mainClass>com.example.myjson.MyjsonApplication</mainClass>

                    <skip>true</skip>

                </configuration>

            </plugin>

        </plugins>

    </build>

 

</project>

加红色的三个依赖，fastjson是我们需要的第三方依赖，其他的spring-boot-configuration-processor 依赖是可选的，加入此依赖主要是打包时，自动生成配置元信息文件 META-INF/spring-configuration-metadata.json，并放入到 jar 中。绿色的artifact是我们自定义starter的名称，蓝色的插件依赖是我们

  1. 手写starter
  1. 定义我们的service业务类：主要是对传入的对象转换为json字符串，同时在其首位做额外的拼接处理

public class MyJsonService {

    private String prefixName;

    private String suffixName;

 

    public String getPrefixName() {

        return prefixName;

    }

 

    public void setPrefixName(String prefixName) {

        this.prefixName = prefixName;

    }

 

    public String getSuffixName() {

        return suffixName;

    }

 

    public void setSuffixName(String suffixName) {

        this.suffixName = suffixName;

    }

 

    public String objectToMyJson(Object obj) {

        return prefixName + JSON.toJSONString(obj) + suffixName;

    }

}

 

  1. 定义控制的实体类对象

public class Person {

    private String name;

    private int age;

    private String address;

    public Person(String name, int age, String address) {

        super();

        this.name = name;

        this.age = age;

        this.address = address;

    }

 

    public String getName() {

        return name;

    }

 

    public void setName(String name) {

        this.name = name;

    }

 

    public int getAge() {

        return age;

    }

 

    public void setAge(int age) {

        this.age = age;

    }

 

    public String getAddress() {

        return address;

    }

 

    public void setAddress(String address) {

        this.address = address;

    }

}

 

  1. 定义我们的属性配置类（也即yml配置文件中配置的属性）

/**

 * @author：cp

 * @time：2021-4-12

 * @Description: 配置类(类名一般为模块名+Properties) cp.json为Starter使用者通过yml配置文件动态修改属性值的变量名前缀

 */

@ConfigurationProperties(prefix = "cp.json")

public class MyJsonProperties {

    // Starter使用者没在配置文件中配置prefixName属性的值时的默认值

    public static final String DEFAULT_PREFIX_NAME = "@";

 

    // Starter使用者没在配置文件中配置suffixName属性的值时的默认值

    public static final String DEFAULT_SUFFIX_NAME = "#";

    private String prefixName = DEFAULT_PREFIX_NAME;

    private String suffixName = DEFAULT_SUFFIX_NAME;

 

    public String getPrefixName() {

        return prefixName;

    }

 

    public void setPrefixName(String prefixName) {

        this.prefixName = prefixName;

    }

 

    public String getSuffixName() {

        return suffixName;

    }

 

    public void setSuffixName(String suffixName) {

        this.suffixName = suffixName;

    }

}

 

  1. 定义自动装配类，让spring装配我们的service业务类，同时调用我们的属性配置类，让业务service类获取到属性配置类的值并进行处理

package com.example.myjson.config;

 

import com.example.myjson.service.MyJsonService;

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;

 

/**

 * @author：cp

 * @time：2021-4-12

 * @Description: 自动装配类

 */

@Configuration

@ConditionalOnClass(MyJsonService.class) // 表示只有指定的class在classpath上时才能被注册

@EnableConfigurationProperties(MyJsonProperties.class)

// 激活被@ConfigurationProperties注解修饰的类

public class MyJsonConfiguration {

    private MyJsonProperties myJsonProperties;

 

    // 自动注入配置类

    public MyJsonConfiguration(MyJsonProperties myJsonProperties) {

        this.myJsonProperties = myJsonProperties;

    }

 

    // 创建MyJsonService对象，注入到Spring容器中

    @Bean

    @ConditionalOnMissingBean(MyJsonService.class)  // 当容器没有此bean时，才注册

    public MyJsonService myJsonService() {

        MyJsonService myJsonService = new MyJsonService();

        myJsonService.setPrefixName(myJsonProperties.getPrefixName());

        myJsonService.setSuffixName(myJsonProperties.getSuffixName());

        return myJsonService;

    }

}

 

  1. 在我们的启动类模块的resources文件下创建META-INF/spring.factories 文件，增加如下内容，将自动装配的类配置上

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\

com.example.myjson.config.MyJsonConfiguration

 

  1. 上述工作完成后，我们可以使用mvn install命令在本地仓库生成我们手写的starter的jar，可以提供给他其他工程依赖引用。也可以快捷的使用idea提供的快捷打包
  2. 新建一个工程，名称为kk，流程同（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 https://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.4.4</version>

        <relativePath/> <!-- lookup parent from repository -->

    </parent>

    <groupId>com.example</groupId>

    <artifactId>kk</artifactId>

    <version>0.0.1-SNAPSHOT</version>

    <name>kk</name>

    <description>Demo project for Spring Boot</description>

    <properties>

        <java.version>1.8</java.version>

    </properties>

    <dependencies>

        <dependency>

            <groupId>org.springframework.boot</groupId>

            <artifactId>spring-boot-starter-web</artifactId>

        </dependency>

        <dependency>

            <groupId>com.example</groupId>

            <artifactId>myjson-spring-boot-starter-autoconfigurer</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>

 

    <build>

        <plugins>

            <plugin>

                <groupId>org.springframework.boot</groupId>

                <artifactId>spring-boot-maven-plugin</artifactId>

            </plugin>

        </plugins>

    </build>

 

</project>

 

  1. 更新maven依赖后，可以看我们的自定义starter已经被引入进来，在kk工程的resources文件下将application.properties文件改为application.yml并进行如下配置

cp:

  json:

    prefix-name: hello

    suffix-name: world

 

  1. 在kkApplication下新建controller

@RestController

@RequestMapping("demo")

public class DemoController {

    @Autowired

    private MyJsonService myJsonService;

 

    @GetMapping()

    public String test() {

        Person p = new Person(“千与千寻” , 18, "拉斯维加斯");

        // 调用服务方法

        return myJsonService.objectToMyJson(p);

    }

}

引入我们自定义启动器中的业务service类，启动springboot工程，访问http://localhost:8080/demo，验证我们的service类即可。

中间问题点：在打包自定义启动器类jar包本地仓库时，没有添加构建插件，导致生成包多了一个BOOT-INF的文件，无法被其他工程引用导入自定义service类：添加如下构建插件后问题解决：

<build>

        <plugins>

            <plugin>

                <groupId>org.springframework.boot</groupId>

                <artifactId>spring-boot-maven-plugin</artifactId>

                <configuration>

                    <mainClass>com.example.myjson.MyjsonApplication</mainClass>

                    <skip>true</skip>

                </configuration>

            </plugin>

        </plugins>

    </build>

 

 

常敲代码手不生
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
springboot手写一个自己的starter
08-25
在本篇文章里小编给大家整理了关于springboot手写一个自己的starter源码的全部知识点内容，需要的朋友们学习下。
源码____手写SpringBoot启动器
a1694375032的博客
03-28 260
非常简单的一个启动器，功能只是调用方法传入参数，启动器就会自动添加前后缀（需自动在配置文件中配置）并打印 一、项目结构 starter项目是一个空项目，只需要引用autoconfigure到pom即可 二、autoconfigure代码 1.HelloService.java 这里是启动器具体功能的实现。 此类功能是添加前后缀并打印 package com.xiong.spring.boot.a...
最新手把手教你手写一个最简单的 Spring Boot Starter(1)，大专生三面蚂蚁金服
最新发布
2301_79655589的博客
05-14 410
搞定算法，面试字节再不怕，有需要文章中分享的这些最后再分享一份1.2.73业务处理类，实现 Java 对象转换为带有指定前后缀的 JSON 字符串。/**@Description 业务处理类*/// 前缀// 后缀/**将Java对象转为带有指定前后缀的JSON字符串@param o 需要转换的Java对象@return 转换后的字符串*/配置类，定义需要的配置信息和默认配置项，并指明关联配置文件的配置项前缀。
SpringBoot学习笔记(四)——手写自定义SpringBoot启动器
虚心学习，和气编码
04-03 778
今天是清明节的第一天假期，原本的学习计划是学习RocketMQ的，但是发现一个好玩的东西，自定义SpringBoot启动器，这东西逼格高啊。所以今天学习的内容就是手写一个自定义的SpringBoot的启动器，简单学习之后再去学习RocketMQ。
手写SpringBoot启动器的主要步骤
qq_62669410的博客
04-20 438
定义业务接口、需要的实体类等业务对象 定义配置属性类、 定义自动装配类、 Resources目录下新建META-INF/spring.factories，加入自定义starter的配置项 创建一个maven 项目 在项目内的 pom.xml 中导入依赖 <dependency> <groupId>org.springframework.boot</groupId> ...
手写springboot启动器, 学习SpringBoot的最佳实践
03-19 1397
*** 自定义的SpringBootApplication启动类*/// 创建一个Spring容器// 注册启动类// 刷新容器// 从spring容器中获取WebServer bean 这样就可以解耦 避免if else判断要使用那个WebServer了/*** 这里通过使用上下文中的 getBeansOfType 方法,通过将接口类来获取容器中的所有实现类,从而达到解耦的目的.* @return*/
手写SpringBoot框架
02-16
这个"手写SpringBoot框架"项目旨在帮助开发者深入理解SpringBoot的工作原理，通过阅读其底层源码并尝试自己实现，以此提升对框架的掌控力。 首先，SpringBoot的核心在于“约定优于配置”，它通过自动配置、起步依赖...
手写自己的Springboot, 从Servlet容器选择彻底理解自动配置
05-14
7. **启动器类**：类似于Spring Boot的`@SpringBootApplication`，我们需要创建一个启动类，应用我们的`@MyAutoConfigure`注解，并使用`SpringApplication.run()`方法启动应用。 8. **应用上下文**：理解Spring ...
springboot.7z
06-04
- **内嵌服务器**：Spring Boot 可以内嵌 Tomcat 或 Jetty 等服务器，无需额外配置即可启动应用。 2. **JWT（JSON Web Token）**： - **身份验证**：JWT 提供了一种轻量级的身份验证机制，用户登录后会返回一个...
详解mall整合SpringBoot+MyBatis搭建基本骨架
08-25
SpringBoot可以让你快速构建基于Spring的Web应用程序，内置多种Web容器（如Tomcat），通过启动入口程序的main函数即可运行。PageHelper是MyBatis的分页插件，简单的几行代码就能实现分页，在与SpringBoot整合时，...
简单的springboot
03-27
通过内置的依赖管理和启动器，SpringBoot可以帮助开发者快速构建可独立运行的Java应用程序，无论是命令行应用还是Web应用。 在"简单的SpringBoot"这个项目中，我们看到它是一个基于Maven构建的工程。Maven是Apache...
Spring Boot 自定义starter启动器(demo).zip
04-05
Spring Boot 自定义starter启动器 Demo 部分，用于记录使用。该demo 配套教程 https://blog.csdn.net/lzb348110175/article/details/105330274。
如何手写一个springboot starter？
JQ棣的博客
02-12 627
本文主要分享了如何手写一个spring starter，把你的代码作为jar包进行开源。
手写SpringBoot的starter
weixin_45565886的博客
02-24 546
手写SpringBoot的starter
手写SpringBoot的启动器
BaseLike的博客
08-22 485
启动器模块是一个空 JAR 文件，仅提供辅助性依赖管理，这些依赖可能用于自动 装配或者其他类库，命名规范如下： 官方命名 : spring-boot-starter-模块名(eg：spring-boot-starter-web、spring-boot-starter-jdbc、spring-boot-starter-thymeleaf) 自定义命名 : 模块名-spring-boot-starter (eg：mybatis-spring-boot-start) 如何编写自动配置 @Configuratio
手写SpringBoot
qq_19428261的博客
05-26 338
手写SpringBoot扩展------使用注解方式启动测试---------------省略代码------[手写SpringBoot](https://github.com/ZhouZhiJ/my-spring-boot-1.0.git) 新建ServletConfig.java 配置视图解析器 package com.zhouzj.config; import org.springfra...
这样手写Spring Boot 启动配置的操作，有点骚
m0_68103666的博客
04-13 128
最近在做新员工培训的则是Spring Boot部分的内容，这部分也是面试常问的点
手写SpringBoot启动器主要步骤
Circ
06-15 1206
MyComponent ：装配注解MyAutowired ：属性注入的注解MyComponentScan ：扫包的注解通过自定义注解（@MyComponent和@MyAutowired），你可以标识需要被Spring容器管理的组件，以及需要进行属性注入的依赖关系。这样可以实现基于注解的组件装配和依赖注入，简化了配置和编码工作。
手写springboot启动器
10-18
好的，以下是手写Spring Boot启动器的步骤： 1. 创建一个Maven项目，作为启动器项目。 2. 在项目中创建一个类，实现SpringApplicationRunListener接口，用于监听Spring Boot应用的启动事件。 3. 在resources/META-...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值