经验首页 前端设计 程序设计 Java相关 移动开发 数据库/运维 软件/图像 大数据/云计算 其他经验
当前位置：技术经验 » Java相关 » Spring Boot » 查看文章
通用权限系统-Spring-Boot-Starter
来源：cnblogs　　作者：JavaCoderPan　　时间：2023/7/10 9:58:37　　对本文有异议

Spring-Boot-Starter

自定义Starter

案例一：读取application.yml中的参数

1、创建

1、创建maven工程hello-spring-boot-starter
image
2、pom中添加依赖

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0"
  3.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  5.     <modelVersion>4.0.0</modelVersion>
  7.     <groupId>org.example</groupId>
  8.     <artifactId>hello-spring-boot-starter</artifactId>
  9.     <version>1.0-SNAPSHOT</version>
  11.     <properties>
  12.         <maven.compiler.source>8</maven.compiler.source>
  13.         <maven.compiler.target>8</maven.compiler.target>
  14.         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  15.     </properties>
  16.     <parent>
  17.         <groupId>org.springframework.boot</groupId>
  18.         <artifactId>spring-boot-starter-parent</artifactId>
  19.         <version>2.2.2.RELEASE</version>
  20.         <relativePath/>
  21.     </parent>
  22.     <dependencies>
  23.         <dependency>
  24.             <groupId>org.springframework.boot</groupId>
  25.             <artifactId>spring-boot-starter</artifactId>
  26.         </dependency>
  27.         <dependency>
  28.             <groupId>org.springframework.boot</groupId>
  29.             <artifactId>spring-boot-autoconfigure</artifactId>
  30.         </dependency>
  31.     </dependencies>
  32. </project>

3、创建HelloProperties
配置属性类，用于封装配置文件中配置的参数信息

  1. package org.example.config;
  3. import org.springframework.boot.context.properties.ConfigurationProperties;
  5. /**
  6.  * TODO 配置属性类，用于封装配置文件中配置的参数信息
  7.  *
  8.  * @author ss_419
  9.  * @version 1.0
  10.  * @date 2023/7/8 13:55
  11.  */
  12. @ConfigurationProperties(prefix = "hello")
  13. public class HelloProperties {
  14.     private String name;
  15.     private String address;
  17.     public String getName() {
  18.         return name;
  19.     }
  21.     public void setName(String name) {
  22.         this.name = name;
  23.     }
  25.     public String getAddress() {
  26.         return address;
  27.     }
  29.     public void setAddress(String address) {
  30.         this.address = address;
  31.     }
  33.     @Override
  34.     public String toString() {
  35.         return "HelloProperties{" +
  36.                 "name='" + name + '\'' +
  37.                 ", address='" + address + '\'' +
  38.                 '}';
  39.     }
  40. }

4、创建HelloService
这个类用于对读取到的参数进行一些业务上的操作

  1. package org.example.service;
  3. /**
  4.  * TODO
  5.  *
  6.  * @author ss_419
  7.  * @version 1.0
  8.  * @date 2023/7/8 14:03
  9.  */
  10. public class HelloService {
  11.     private String name;
  12.     private String address;
  14.     public HelloService(String name, String address) {
  15.         this.name = name;
  16.         this.address = address;
  17.     }
  19.     public String sayHello(){
  20.         return "你好！我的名字叫做"+name+"，地址是" + address;
  21.     }
  22. }

5、创建HelloServiceAutoConfiguration（用于自动配置HelloService对象）

  1. package org.example.config;
  3. import org.example.service.HelloService;
  4. import org.springframework.beans.factory.annotation.Autowired;
  5. import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
  6. import org.springframework.boot.context.properties.EnableConfigurationProperties;
  7. import org.springframework.context.annotation.Bean;
  8. import org.springframework.context.annotation.Configuration;
  10. /**
  11.  * TODO 自动配置类
  12.  * 通过@Configuration + @Bean 实现自动创建对象
  13.  *
  14.  * @author ss_419
  15.  * @version 1.0
  16.  * @date 2023/7/8 14:06
  17.  */
  18. @Configuration
  19. // 一定要加上这个注解，否则Spring找不到这个配置类
  20. @EnableConfigurationProperties(value = HelloProperties.class)
  21. public class HelloServiceAutoConfiguration {
  24.     private HelloProperties helloProperties;
  26.     // 通过构造方法注入配置属性对象HelloProperties
  27.     public HelloServiceAutoConfiguration(HelloProperties helloProperties) {
  28.         this.helloProperties = helloProperties;
  29.     }
  30.     // 实例化HelloService并载入Spring IOC 容器
  31.     @Bean
  32.     @ConditionalOnMissingBean// Spring中没有这个实例的时候再去创建
  33.     public HelloService helloService(){
  34.         return new HelloService(helloProperties.getName(), helloProperties.getAddress());
  35.     }
  36. }

6、在resources目录下创建META-INF/spring.factories

  1. org.springframework.boot.autoconfigure.EnableAutoConfiguration=org.example.config.HelloServiceAutoConfiguration

7、将工程打包到maven仓库中
image

2、使用

1、创建项目，导入自定义starter
image

2、创建application.yml配置文件
image
3、创建启动类

  1. package org.example;
  3. import org.springframework.boot.SpringApplication;
  4. import org.springframework.boot.autoconfigure.SpringBootApplication;
  6. /**
  7.  * TODO
  8.  *
  9.  * @author ss_419
  10.  * @version 1.0
  11.  * @date 2023/7/8 14:39
  12.  */
  13. @SpringBootApplication
  14. public class HelloApplication {
  15.     public static void main(String[] args) {
  16.         SpringApplication.run(HelloApplication.class,args);
  17.     }
  18. }

4、创建测试Controller

  1. package org.example.controller;
  3. import org.example.annotaion.MyLog;
  4. import org.example.service.HelloService;
  5. import org.springframework.beans.factory.annotation.Autowired;
  6. import org.springframework.web.bind.annotation.GetMapping;
  7. import org.springframework.web.bind.annotation.RequestMapping;
  8. import org.springframework.web.bind.annotation.RestController;
  10. /**
  11.  * TODO
  12.  *
  13.  * @author ss_419
  14.  * @version 1.0
  15.  * @date 2023/7/8 14:36
  16.  */
  17. @RestController
  18. @RequestMapping("/hello")
  19. public class HelloController {
  21.     @Autowired
  22.     private HelloService helloService;
  24.     @GetMapping("/sayHello")
  25.     
  26.     public String sayHello() {
  27.      return helloService.sayHello();
  28.     }
  29. }

5、测试
image

案例二：通过自动配置来创建一个拦截器对象，通过此拦截器对象来实现记录日志功能

1、创建

1、创建maven项目并且引入依赖

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0"
  3.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  5.     <modelVersion>4.0.0</modelVersion>
  6.     <parent>
  7.         <groupId>org.springframework.boot</groupId>
  8.         <artifactId>spring-boot-starter-parent</artifactId>
  9.         <version>2.2.2.RELEASE</version>
  10.         <relativePath/>
  11.     </parent>
  12.     <groupId>org.example</groupId>
  13.     <artifactId>log-spring-boot-starter</artifactId>
  14.     <version>1.0-SNAPSHOT</version>
  16.     <properties>
  17.         <maven.compiler.source>8</maven.compiler.source>
  18.         <maven.compiler.target>8</maven.compiler.target>
  19.         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  20.     </properties>
  21.     <dependencies>
  22.         <dependency>
  23.             <groupId>org.springframework.boot</groupId>
  24.             <artifactId>spring-boot-starter</artifactId>
  25.         </dependency>
  26.         <dependency>
  27.             <groupId>org.springframework.boot</groupId>
  28.             <artifactId>spring-boot-autoconfigure</artifactId>
  29.         </dependency>
  30.         <dependency>
  31.             <groupId>org.springframework.boot</groupId>
  32.             <artifactId>spring-boot-starter-web</artifactId>
  33.         </dependency>
  34.     </dependencies>
  35. </project>

2、创建MyLog注解

  1. package org.example.annotaion;
  3. import java.lang.annotation.ElementType;
  4. import java.lang.annotation.Retention;
  5. import java.lang.annotation.RetentionPolicy;
  6. import java.lang.annotation.Target;
  8. @Target(ElementType.METHOD)
  9. @Retention(RetentionPolicy.RUNTIME)
  10. public @interface MyLog {
  11.     /**
  12.      * 方法描述
  13.      * @return
  14.      */
  15.     String desc() default "";
  16. }

3、创建日志拦截器

  1. package org.example.interceptor;
  3. import org.example.annotaion.MyLog;
  4. import org.springframework.web.method.HandlerMethod;
  5. import org.springframework.web.servlet.ModelAndView;
  6. import org.springframework.web.servlet.handler.HandlerInterceptorAdapter;
  8. import javax.servlet.http.HttpServletRequest;
  9. import javax.servlet.http.HttpServletResponse;
  10. import java.lang.reflect.Method;
  12. /**
  13.  * TODO 自定义日志拦截器
  14.  *
  15.  * @author ss_419
  16.  * @version 1.0
  17.  * @date 2023/7/8 17:43
  18.  */
  19. public class MyLogInterceptor extends HandlerInterceptorAdapter {
  20.     private static final ThreadLocal<Long> startTimeThreadLocal = new ThreadLocal<>();// 记录时间毫秒值
  22.     /**
  23.      * 执行之前
  24.      * @param request
  25.      * @param response
  26.      * @param handler
  27.      * @return
  28.      * @throws Exception
  29.      */
  30.     @Override
  31.     public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
  32.         // 进行转换
  33.         HandlerMethod handlerMethod = (HandlerMethod) handler;
  34.         Method method = handlerMethod.getMethod();
  35.         // 获取方法上的注解MyLog
  36.         MyLog annotation = method.getAnnotation(MyLog.class);
  37.         if(annotation != null){
  38.             // 说明当前拦截到的方法上加入了MyLog注解
  39.             long currentTimeMillis = System.currentTimeMillis();
  40.             startTimeThreadLocal.set(currentTimeMillis);
  41.         }
  42.         return true;
  43.     }
  45.     /**
  46.      * 执行之后
  47.      * @param request
  48.      * @param response
  49.      * @param handler
  50.      * @param modelAndView
  51.      * @throws Exception
  52.      */
  53.     @Override
  54.     public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
  55.         HandlerMethod handlerMethod = (HandlerMethod) handler;
  56.         Method method = handlerMethod.getMethod();
  58.         // 获取方法上的注解MyLog
  59.         MyLog annotation = method.getAnnotation(MyLog.class);
  60.         if(annotation != null){
  61.             // 说明当前拦截到的方法上加入了MyLog注解
  62.             Long startTime = startTimeThreadLocal.get();
  63.             long endTime = System.currentTimeMillis();
  64.             long optTime =  endTime - startTime;
  66.             String requestUri = request.getRequestURI();
  67.             String methodName = method.getDeclaringClass().getName() + "."+
  68.                                 method.getName()+"()";
  69.             String methodDesc = annotation.desc();
  71.             System.out.println("请求uri："+requestUri);
  72.             System.out.println("请求方法名："+methodName);
  73.             System.out.println("方法描述："+methodDesc);
  74.             System.out.println("方法执行时间："+optTime+"ms");
  76.         }
  77.         super.postHandle(request, response, handler, modelAndView);
  78.     }
  79. }

4、创建自动装配对象

  1. package org.example.config;
  3. import org.example.interceptor.MyLogInterceptor;
  4. import org.springframework.context.annotation.Configuration;
  5. import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
  6. import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
  8. /**
  9.  * TODO
  10.  *
  11.  * @author ss_419
  12.  * @version 1.0
  13.  * @date 2023/7/8 18:08
  14.  */
  15. @Configuration
  16. public class MyLogAutoConfiguration implements WebMvcConfigurer {
  17.     /**
  18.      * 注册自定义日志拦截器
  19.      * @param registry
  20.      */
  21.     @Override
  22.     public void addInterceptors(InterceptorRegistry registry) {
  23.         registry.addInterceptor(new MyLogInterceptor());
  24.     }
  25. }

5、在resources下创建META-INF，在该文件夹下创建spring.factories
该配置文件用于扫描自动装配类

  1. org.springframework.boot.autoconfigure.EnableAutoConfiguration=org.example.config.MyLogAutoConfiguration

2、使用

1、创建一个web项目，并且引入依赖，pom.xml如下：

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0"
  3.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  5.     <modelVersion>4.0.0</modelVersion>
  7.     <groupId>org.example</groupId>
  8.     <artifactId>use-my-spring-boot-starter-demo</artifactId>
  9.     <version>1.0-SNAPSHOT</version>
  10.     <parent>
  11.         <groupId>org.springframework.boot</groupId>
  12.         <artifactId>spring-boot-starter-parent</artifactId>
  13.         <version>2.2.2.RELEASE</version>
  14.         <relativePath/>
  15.     </parent>
  16.     <properties>
  17.         <maven.compiler.source>8</maven.compiler.source>
  18.         <maven.compiler.target>8</maven.compiler.target>
  19.         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  20.     </properties>
  21.     <dependencies>
  22.         <dependency>
  23.             <groupId>org.example</groupId>
  24.             <artifactId>log-spring-boot-starter</artifactId>
  25.             <version>1.0-SNAPSHOT</version>
  26.         </dependency>
  27.         <dependency>
  28.             <groupId>org.springframework.boot</groupId>
  29.             <artifactId>spring-boot-starter-web</artifactId>
  30.         </dependency>
  31.         <dependency>
  32.             <groupId>org.example</groupId>
  33.             <artifactId>hello-spring-boot-starter</artifactId>
  34.             <version>1.0-SNAPSHOT</version>
  35.         </dependency>
  36.     </dependencies>
  38. </project>

2、创建测试Controller
在测试的方法上添加上自定义的MyLog注解，当该方法执行的时候就会在控制台输出对应信息

  1. package org.example.controller;
  3. import org.example.annotaion.MyLog;
  4. import org.example.service.HelloService;
  5. import org.springframework.beans.factory.annotation.Autowired;
  6. import org.springframework.web.bind.annotation.GetMapping;
  7. import org.springframework.web.bind.annotation.RequestMapping;
  8. import org.springframework.web.bind.annotation.RestController;
  10. /**
  11.  * TODO
  12.  *
  13.  * @author ss_419
  14.  * @version 1.0
  15.  * @date 2023/7/8 14:36
  16.  */
  17. @RestController
  18. @RequestMapping("/hello")
  19. public class HelloController {
  21.     @Autowired
  22.     private HelloService helloService;
  24.     @GetMapping("/sayHello")
  25.     @MyLog(desc = "sayHello方法")
  26.     public String sayHello() {
  27.      return helloService.sayHello();
  28.     }
  29. }

3、测试
image

到这里，对于自定义starter的案例就结束了。

原文链接：https://www.cnblogs.com/atwood-pan/p/17537825.html

 友情链接：直通硅谷 　点职佳 　北美留学生论坛

Spring Boot热门文章

  • 史上最详 Thymeleaf 使用教程
  • Spring Boot如何通过java -jar启动
  • Spring Boot 2.x（六）：优雅的统一返回值
  • Springboot使用Logback实现日志配置与异常记录
  • 使用SpringBoot+EasyExcel+Vue实现excel表格的导入和导出详解
  • spring boot上传文件超出大小异常无法捕获问题
  • paging组件的用法和意义
  • springboot2.0集成rabbitmq的示例代码
  • Spring MVC学习step1——框架熟悉
  • spring boot ${}占位符不起作用的解决方案

    • Spring Boot推荐文章

  • 3分钟带你搞定Spring Boot中Schedule
  • 不单独部署注册中心，又要具备注册中心的功能，我能上天！
  • 从零开始学Spring Boot系列-集成Spring Security实现用户认证与授权
  • 不单独部署注册中心，又要具备注册中心的功能，咋不让我上天？
  • EasyExcel 无法读取图片？用poi写了一个工具类
  • 【进阶篇】使用 Stream 流对比两个集合的常用操作分享
  • 关于DDD和COLA的一些总结和思考
  • SnakeYaml反序列化分析
  • RestTemplate进行https请求时适配信任证书
  • Kryo反序列化链分析

    • 本站QQ群：前端 618073944 | Java 606181507 | Python 626812652 | C/C++ 612253063 | 微信 634508462 | 苹果 692586424 | C#/.net 182808419 | PHP 305140648 | 运维 608723728

    W3xue 的所有内容仅供测试，对任何法律问题及风险不承担任何责任。通过使用本站内容随之而来的风险与本站无关。
    关于我们  |  意见建议  |  捐助我们  |  报错有奖  |  广告合作、友情链接（目前9元/月）请联系QQ：27243702 沸活量
    皖ICP备17017327号-2　皖公网安备34020702000426号