SpringBoot——自定义一个spring-boot-starter包

简介: SpringBoot——自定义一个spring-boot-starter包

一句话总结:

1、编写自己的properties类(用来加载属性文件进行默认的配置)和核心服务类(要自动配置的bean)

2、自定义AutoConfiguration 配置类CustomerAutoConfiguration ,通过@Condition*系列注解控制自动配置的条件。

3、然后在src/main/resources新建文件夹META-INF,然后新建一个spring.factories文件

在里面使用org.springframework.boot.autoconfigure.EnableAutoConfiguration指定我们自定义的自动配置类的全路径。

这样,一个自定义的spring-boot-start工程就完成了。


命名规则:

这里啰嗦一下,官方对 Starter 包定义的 artifactId 是有要求的,当然也可以不遵守(手动滑稽)。

Spring 官方 Starter 通常命名为 spring-boot-starter-{name}如:spring-boot-starter-web,

比如:spring-cloud-starter-openfeign

Spring 官方建议非官方的 Starter 命名应遵守 {name}-spring-boot-starter 的格式。

比如:mybatis-spring-boot-starter


先简单分析下mybatis-spring-boot-starter的结构:

父包:mybatis-spring-boot 核心功能模块

子包:

mybatis-spring-boot-starter
mybatis-spring-boot-autoconfigure

29.png

1、发现mybatis-spring-boot-starter工程本身是个空项目,只通过pom文件和spring.provides说明依赖关系;

其中spring.provides是依赖文件jar包配置的artifactId值


2、在mybatis-spring-boot-autoconfigure工程中发现spring.facoties文件,

内容为:

# Auto Configure
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
org.mybatis.spring.boot.autoconfigure.MybatisAutoConfiguration


核心代码中只有三个类文件:

1、MybatisAutoConfiguration 自动配置类

2、MybatisProperties 属性文件加载类,通过@EnableConfigurationProperties({MybatisProperties.class})注入到spring容器中,使得在MybatisAutoConfiguration中可以直接注入使用配置属性

3、SpringBootVFS 是类扫描器

打包成jar时,setTypeAliasesPackage(“xxx”)找不到类的问题。MyBatis通过VFS来扫描,

在Spring Boot中由于是嵌套Jar,导致Mybatis默认的VFS实现DefaultVFS无法扫描嵌套Jar中的类,需要改成SpringBootVFS扫描。

27.png


28.png



通过分析总结一些基础步骤:

本文demo参考mybatis-spring-boot-starter和网上的文章创建自己的start工程。

定义我们自己的spring boot starter工程,通常需要以下4个工程:


模块的真正的实现类,如本文的工程为first-spring-boot/-spring的工程:此工程是-spring-boot-autoconfigure和*-spring-boot-starter的父工程类。本例子里是first-spring-boot。

此工程的命名规则如下:如果你在这个工程中引入spring依赖,则工程名称为*-spring,如果引入spring-boot依赖,则工程名称为*-spring-boot。

*-spring-boot-autoconfigure工程:配置自动配置类,本例的名称first-spring-boot-autoconfigure

*-spring-boot-starter工程:空工程类,在pom.xml中定义需要引入jar,本例的名称first-spring-boot-starter

为了能更好的理解Springboot的自动配置和工作原理,我们今天来手写一个spring-boot-hello-starter。这个过程很简单,代码不多。接下来我们看看怎么开始实践。


1. 新建maven工程。


这块就不演示了,如果不会可以自行百度…啦啦啦,因为太简单了啊


2.新建一个properties类


/**
 * @author Lee
 * @// TODO 2018/7/25-9:21
 * @description
 */
@ConfigurationProperties(prefix = "customer")
public class CustomerProperties {
    private static final String DEFAULT_NAME = "Lensen";
    private String name = DEFAULT_NAME;
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
}


3.创建一个服务类CustomerService


/**
     * @author Lee
     * @// TODO 2018/7/25-10:30
     * @description
     */
    public class CustomerService {
        private String name;
    public String findCustomer(){
        return "The Customer is " + name;
    }
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
}


4.AutoConfiguration类


/**
 * @author Lee
 * @// TODO 2018/7/25-10:32
 * @description
 */
@Configuration
@EnableConfigurationProperties(CustomerProperties.class)
@ConditionalOnClass(CustomerService.class)
@ConditionalOnProperty(prefix = "customer", value = "enabled", matchIfMissing = true)
public class CustomerAutoConfiguration {
    @Autowired
    private CustomerProperties customerProperties;
    @Bean
    @ConditionalOnMissingBean(CustomerService.class)
    public CustomerService customerService() {
        CustomerService customerService = new CustomerService();
        customerService.setName(customerProperties.getName());
        return customerService;
    }
}

核心注解说明:


@Configuration声明是配置类


@EnableConfigurationProperties(CustomerProperties.class)

将被 @ConfigurationProperties修饰的类CustomerProperties加载到spring容器中

@ConditionalOnClass(CustomerService.class)

只有在项目路径下加载到CustomerService类,才会进行自动配置

@ConditionalOnProperty(prefix = “customer”, value = “name”,matchIfMissing = true)

检查配置文件中,是否有以customer开头名称为enabled的配置, 由于允许属性缺失,所以仍然会自动配置。


5. spring.factories配置


在src/main/resources新建文件夹META-INF,然后新建一个spring.factories文件

org.springframework.boot.autoconfigure.EnableAutoConfiguration=
com.developlee.configurer.CustomerAutoConfiguration

pom文件修改artifactId为spring-boot-hello-starter 打包成jar. 然后用mvn install 安装到本地mvn仓库。


测试spring-boot-hello-start

新建springboot工程,在pom.xml文件引入安装的jar包

com.developlee spring-boot-hello-starter 1.0-SNAPSHOT

在项目启动类中直接做测试:

@SpringBootApplication
@RestController
public class TestStarterApplication {
@Autowired
CustomerService customerService;
@GetMapping("/")
public String index(){
    return customerService.getName();
}
public static void main(String[] args) {
    SpringApplication.run(TestStarterApplication.class, args);
}
}

application.properties文件配置下我们的customer.name

customer.name = BigBBrother

接下来启动项目,请求地址localhost:8080,即可看到页面上显示BigBBrother。


到这我们已经完成了一个spring-boot-starter jar包的开发,有很多功能我们可以自己封装成一个jar,以后要用直接引用就行了~ 这样写代码是不是会有不一样的体验呢?

目录
相关文章
|
1月前
|
XML Java 应用服务中间件
SpringBoot项目打war包流程
本文介绍了将Spring Boot项目改造为WAR包并部署到外部Tomcat服务器的步骤。主要内容包括:1) 修改pom.xml中的打包方式为WAR;2) 排除Spring Boot内置的Tomcat依赖;3) 添加Servlet API依赖;4) 改造启动类以支持WAR部署;5) 打包和部署。通过这些步骤,可以轻松地将Spring Boot应用转换为适合外部Tomcat服务器的WAR包。
154 64
SpringBoot项目打war包流程
|
16天前
|
Java Maven 开发者
编写SpringBoot的自定义starter包
通过本文的介绍,我们详细讲解了如何创建一个Spring Boot自定义Starter包,包括自动配置类、配置属性类、`spring.factories`文件的创建和配置。通过自定义Starter,可以有效地复用公共配置和组件,提高开发效率。希望本文能帮助您更好地理解和应用Spring Boot自定义Starter,在实际项目中灵活使用这一强大的功能。
42 17
|
9天前
|
Java 应用服务中间件 Maven
SpringBoot项目打包成war包
通过上述步骤,我们成功地将一个Spring Boot应用打包成WAR文件,并部署到外部的Tomcat服务器中。这种方式适用于需要与传统Servlet容器集成的场景。
29 8
|
3天前
|
前端开发 Java Nacos
🛡️Spring Boot 3 整合 Spring Cloud Gateway 工程实践
本文介绍了如何使用Spring Cloud Alibaba 2023.0.0.0技术栈构建微服务网关,以应对微服务架构中流量治理与安全管控的复杂性。通过一个包含鉴权服务、文件服务和主服务的项目,详细讲解了网关的整合与功能开发。首先,通过统一路由配置,将所有请求集中到网关进行管理;其次,实现了限流防刷功能,防止恶意刷接口;最后,添加了登录鉴权机制,确保用户身份验证。整个过程结合Nacos注册中心,确保服务注册与配置管理的高效性。通过这些实践,帮助开发者更好地理解和应用微服务网关。
21 0
🛡️Spring Boot 3 整合 Spring Cloud Gateway 工程实践
|
1月前
|
监控 Java 应用服务中间件
SpringBoot是如何简化Spring开发的,以及SpringBoot的特性以及源码分析
Spring Boot 通过简化配置、自动配置和嵌入式服务器等特性,大大简化了 Spring 应用的开发过程。它通过提供一系列 `starter` 依赖和开箱即用的默认配置,使开发者能够更专注于业务逻辑而非繁琐的配置。Spring Boot 的自动配置机制和强大的 Actuator 功能进一步提升了开发效率和应用的可维护性。通过对其源码的分析,可以更深入地理解其内部工作机制,从而更好地利用其特性进行开发。
47 6
|
1月前
|
缓存 安全 Java
Spring Boot 3 集成 Spring Security + JWT
本文详细介绍了如何使用Spring Boot 3和Spring Security集成JWT,实现前后端分离的安全认证概述了从入门到引入数据库,再到使用JWT的完整流程。列举了项目中用到的关键依赖,如MyBatis-Plus、Hutool等。简要提及了系统配置表、部门表、字典表等表结构。使用Hutool-jwt工具类进行JWT校验。配置忽略路径、禁用CSRF、添加JWT校验过滤器等。实现登录接口,返回token等信息。
477 12
|
2月前
|
XML Java 数据格式
使用idea中的Live Templates自定义自动生成Spring所需的XML配置文件格式
本文介绍了在使用Spring框架时,如何通过创建`applicationContext.xml`配置文件来管理对象。首先,在resources目录下新建XML配置文件,并通过IDEA自动生成部分配置。为完善配置,特别是添加AOP支持,可以通过IDEA的Live Templates功能自定义XML模板。具体步骤包括:连续按两次Shift搜索Live Templates,配置模板内容,输入特定前缀(如spring)并按Tab键即可快速生成完整的Spring配置文件。这样可以大大提高开发效率,减少重复工作。
使用idea中的Live Templates自定义自动生成Spring所需的XML配置文件格式
|
2月前
|
设计模式 XML Java
【23种设计模式·全精解析 | 自定义Spring框架篇】Spring核心源码分析+自定义Spring的IOC功能,依赖注入功能
本文详细介绍了Spring框架的核心功能,并通过手写自定义Spring框架的方式,深入理解了Spring的IOC(控制反转)和DI(依赖注入)功能,并且学会实际运用设计模式到真实开发中。
【23种设计模式·全精解析 | 自定义Spring框架篇】Spring核心源码分析+自定义Spring的IOC功能,依赖注入功能
|
1月前
|
存储 安全 Java
Spring Boot 3 集成Spring AOP实现系统日志记录
本文介绍了如何在Spring Boot 3中集成Spring AOP实现系统日志记录功能。通过定义`SysLog`注解和配置相应的AOP切面,可以在方法执行前后自动记录日志信息,包括操作的开始时间、结束时间、请求参数、返回结果、异常信息等,并将这些信息保存到数据库中。此外,还使用了`ThreadLocal`变量来存储每个线程独立的日志数据,确保线程安全。文中还展示了项目实战中的部分代码片段,以及基于Spring Boot 3 + Vue 3构建的快速开发框架的简介与内置功能列表。此框架结合了当前主流技术栈,提供了用户管理、权限控制、接口文档自动生成等多项实用特性。
91 8
|
2月前
|
NoSQL Java Redis
Spring Boot 自动配置机制:从原理到自定义
Spring Boot 的自动配置机制通过 `spring.factories` 文件和 `@EnableAutoConfiguration` 注解,根据类路径中的依赖和条件注解自动配置所需的 Bean,大大简化了开发过程。本文深入探讨了自动配置的原理、条件化配置、自定义自动配置以及实际应用案例,帮助开发者更好地理解和利用这一强大特性。
188 14