spring boot 自定义starter的实现教程

 更新时间:2017年12月13日 09:26:56   作者:Sniper_ZL  
下面小编就为大家分享一篇spring boot 自定义starter的实现教程,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧

spring boot 使用 starter 解决了很多配置问题, 但是, 他是怎么来解决这些问题的呢?

这里通过一个简单的例子, 来看一下, starter是怎么来设置默认配置的.

一. 建 starter 项目

自定义的starter, 项目命名规范是: 自定义名-spring-boot-starter

先来看一下, 我最后的目录结构

1. 修改pom.xml文件

<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>org.elvin</groupId>
 <artifactId>my-spring-boot-starter</artifactId>
 <version>1.0-SNAPSHOT</version>
 <packaging>jar</packaging>
 <name>my-spring-boot-starter</name>
 <url>http://maven.apache.org</url>
 <properties>
 <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
 </properties>
 <dependencies>
 <dependency>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-autoconfigure</artifactId>
 <version>1.5.9.RELEASE</version>
 </dependency>
 <dependency>
 <groupId>junit</groupId>
 <artifactId>junit</artifactId>
 <version>3.8.1</version>
 <scope>test</scope>
 </dependency>
 </dependencies>
 <build>
 <plugins>
 <plugin>
 <groupId>org.apache.maven.plugins</groupId>
 <artifactId>maven-compiler-plugin</artifactId>
 <version>2.3.2</version>
 <configuration>
  <source>1.8</source>
  <target>1.8</target>
 </configuration>
 </plugin>
 </plugins>
 </build>
</project>

其实只是加入了 spring-boot-autoconfigure

App文件中的main方法, 我注释掉了, 这个在这里没有用到

2. 配置属性对应的接收文件

package org.elvin;
import org.springframework.boot.context.properties.ConfigurationProperties;/**
 * author: Elvin
 * Date: 2017/12/12 14:51
 * Description:
 */
@ConfigurationProperties(prefix = "hello")
public class HelloServiceProperties {
 //默认配置内容
 private static final String MSG = "world";
 private String msg = MSG;
 public String getMsg() {
 return msg;
 }
 public void setMsg(String msg) {
 this.msg = msg;
 }
}

3. 对外Service

package org.elvin;
/**
 * author: Elvin
 * Date: 2017/12/12 14:55
 * Description:
 */
public class HelloService {
 private String msg;
 public String sayHello(){
 return "Hello " + msg;
 }
 public String getMsg() {
 return msg;
 }
 public void setMsg(String msg) {
 this.msg = msg;
 }
}

4. 对外service与配置对应文件关联

package org.elvin;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
/**
 * author: Elvin
 * Date: 2017/12/12 14:59
 * Description:
 */
@Configuration
@EnableConfigurationProperties(HelloServiceProperties.class)
@ConditionalOnClass(HelloService.class)
@ConditionalOnProperty(prefix = "hello", value="enabled", matchIfMissing =true )
public class HelloServiceAutoConfiguration {
 @Autowired
 private HelloServiceProperties helloServiceProperties;
 @Bean
 @ConditionalOnMissingBean(HelloService.class)
 public HelloService helloService(){
 HelloService helloService = new HelloService();
 helloService.setMsg(helloServiceProperties.getMsg());
 return helloService;
 }
}

5. starter配置 : spring.factories

org.springframework.boot.autoconfigure.EnableAutoConfiguration=org.elvin.HelloServiceAutoConfiguration

做完这些之后, 通过 mvn clean install , 打包到maven库里面

二. spring boot 项目使用

新建一个spring boot 项目, 选择web即可.

目录结构:

先看一下引用pom.xml

<dependency>
   <groupId>org.elvin</groupId>
   <artifactId>my-spring-boot-starter</artifactId>
   <version>1.0-SNAPSHOT</version>
  </dependency>

再看一下HelloController

package org.elvin.learn.springboot.controller;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import org.elvin.*;
/**
 * author: Elvin
 * Date: 2017/12/12 15:34
 * Description:
 */
@RestController
@RequestMapping("hello")
public class HelloController {
 @Autowired
 private HelloService helloService;
 @RequestMapping("index")
 public String index(){
  return helloService.sayHello();
 }
}

这里的 HelloService 就是 前面自定义 starter 里面的.

1. 结果: 未配置情况下, 应该是输出 hello world

2. 在配置文件中, 加入 hello.msg=hahahahahah

这个例子很简单, 只是显示一下主要的过程, 别的都是各插件自己的逻辑判断了.

参考资料:

JavaEE开发的颠覆者 Spring Boot实战

以上这篇spring boot 自定义starter的实现教程就是小编分享给大家的全部内容了,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • SpringBoot集成MyBatis的三种方式

    SpringBoot集成MyBatis的三种方式

    Spring Boot与MyBatis的集成为Java开发者提供了一种简便而强大的方式来访问和操作数据库,在本文中,我们将深入解析Spring Boot集成MyBatis的多种方式,文中有详细的代码示例供大家参考,需要的朋友可以参考下
    2023-12-12
  • Spring事务的七种传播行为

    Spring事务的七种传播行为

    这篇文章主要介绍了Spring事务的七种传播行为,文章围绕主题的相关资料展开详细的内容解说,具有一定的参考价值,需要的小伙伴可以参考一下
    2022-04-04
  • springboot 整合mysql实现版本管理通用最新解决方案

    springboot 整合mysql实现版本管理通用最新解决方案

    当springboot微服务项目完成从开发到测试全流程后,通常来说,最终交付产物是一个完整的安装包,这篇文章主要介绍了springboot 整合mysql实现版本管理通用解决方案,需要的朋友可以参考下
    2023-08-08
  • SpringMVC跨服务器上传文件中出现405错误的解决

    SpringMVC跨服务器上传文件中出现405错误的解决

    这篇文章主要介绍了SpringMVC跨服务器上传文件中出现405错误的解决方案,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-09-09
  • 深入理解java线程通信

    深入理解java线程通信

    开发中不免会遇到需要所有子线程执行完毕通知主线程处理某些逻辑的场景。或者是线程 A 在执行到某个条件通知线程 B 执行某个操作。下面我们来一起学习如何解决吧
    2019-05-05
  • Jar打包用法详解

    Jar打包用法详解

    这篇文章主要介绍了Jar打包用法,详解分析了jar打包命令的各种常见用法及参数含义,非常具有实用价值,需要的朋友可以参考下
    2014-12-12
  • 解决springmvc+mybatis+mysql中文乱码问题

    解决springmvc+mybatis+mysql中文乱码问题

    这篇文章主要介绍了解决java中springmvc+mybatis+mysql中文乱码问题的相关资料,需要的朋友可以参考下
    2015-09-09
  • Spring中基于xml的AOP实现详解

    Spring中基于xml的AOP实现详解

    这篇文章主要介绍了Spring中基于xml的AOP实现详解,基于xml与基于注解的AOP本质上是非常相似的,都是需要封装横切关注点,封装到切面中,然后把横切关注点封装为一个方法,再把该方法设置为当前的一个通知,再通过切入点表达式定位到横切点就可以了,需要的朋友可以参考下
    2023-09-09
  • 使用MyBatis返回其它类对象的字段处理

    使用MyBatis返回其它类对象的字段处理

    这篇文章主要介绍了使用MyBatis返回其它类对象的字段处理方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-08-08
  • Spring事务的失效场景你知道多少

    Spring事务的失效场景你知道多少

    这篇文章主要为大家详细介绍了Spring事务的失效场景,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下,希望能够给你带来帮助
    2022-03-03

最新评论