Spring-Boot-Starter

自定义Starter

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

1、创建

1、创建maven工程hello-spring-boot-starter

2、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 http://maven.apache.org/xsd/maven-4.0.0.xsd">

    <modelVersion>4.0.0</modelVersion>

    <groupId>org.example</groupId>

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

    <version>1.0-SNAPSHOT</version>

    <properties>

        <maven.compiler.source>8</maven.compiler.source>

        <maven.compiler.target>8</maven.compiler.target>

        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>

    </properties>

    <parent>

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

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

        <version>2.2.2.RELEASE</version>

        <relativePath/>

    </parent>

    <dependencies>

        <dependency>

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

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

        </dependency>

        <dependency>

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

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

        </dependency>

    </dependencies>

</project>

3、创建HelloProperties

配置属性类，用于封装配置文件中配置的参数信息

package org.example.config;

import org.springframework.boot.context.properties.ConfigurationProperties;

/**

 * TODO 配置属性类，用于封装配置文件中配置的参数信息

 *

 * @author ss_419

 * @version 1.0

 * @date 2023/7/8 13:55

 */

@ConfigurationProperties(prefix = "hello")

public class HelloProperties {

    private String name;

    private String address;

    public String getName() {

        return name;

    }

    public void setName(String name) {

        this.name = name;

    }

    public String getAddress() {

        return address;

    }

    public void setAddress(String address) {

        this.address = address;

    }

    @Override

    public String toString() {

        return "HelloProperties{" +

                "name='" + name + '\'' +

                ", address='" + address + '\'' +

                '}';

    }

}

4、创建HelloService

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

package org.example.service;

/**

 * TODO

 *

 * @author ss_419

 * @version 1.0

 * @date 2023/7/8 14:03

 */

public class HelloService {

    private String name;

    private String address;

    public HelloService(String name, String address) {

        this.name = name;

        this.address = address;

    }

    public String sayHello(){

        return "你好！我的名字叫做"+name+"，地址是" + address;

    }

}

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

package org.example.config;

import org.example.service.HelloService;

import org.springframework.beans.factory.annotation.Autowired;

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;

/**

 * TODO 自动配置类

 * 通过@Configuration + @Bean 实现自动创建对象

 *

 * @author ss_419

 * @version 1.0

 * @date 2023/7/8 14:06

 */

@Configuration

// 一定要加上这个注解，否则Spring找不到这个配置类

@EnableConfigurationProperties(value = HelloProperties.class)

public class HelloServiceAutoConfiguration {

    private HelloProperties helloProperties;

    // 通过构造方法注入配置属性对象HelloProperties

    public HelloServiceAutoConfiguration(HelloProperties helloProperties) {

        this.helloProperties = helloProperties;

    }

    // 实例化HelloService并载入Spring IOC 容器

    @Bean

    @ConditionalOnMissingBean// Spring中没有这个实例的时候再去创建

    public HelloService helloService(){

        return new HelloService(helloProperties.getName(), helloProperties.getAddress());

    }

}

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

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\

org.example.config.HelloServiceAutoConfiguration

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

2、使用

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

2、创建application.yml配置文件

3、创建启动类

package org.example;

import org.springframework.boot.SpringApplication;

import org.springframework.boot.autoconfigure.SpringBootApplication;

/**

 * TODO

 *

 * @author ss_419

 * @version 1.0

 * @date 2023/7/8 14:39

 */

@SpringBootApplication

public class HelloApplication {

    public static void main(String[] args) {

        SpringApplication.run(HelloApplication.class,args);

    }

}

4、创建测试Controller

package org.example.controller;

import org.example.annotaion.MyLog;

import org.example.service.HelloService;

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.web.bind.annotation.GetMapping;

import org.springframework.web.bind.annotation.RequestMapping;

import org.springframework.web.bind.annotation.RestController;

/**

 * TODO

 *

 * @author ss_419

 * @version 1.0

 * @date 2023/7/8 14:36

 */

@RestController

@RequestMapping("/hello")

public class HelloController {

    @Autowired

    private HelloService helloService;

    @GetMapping("/sayHello")

    public String sayHello() {

     return helloService.sayHello();

    }

}

5、测试

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

1、创建

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

<?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>

    <parent>

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

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

        <version>2.2.2.RELEASE</version>

        <relativePath/>

    </parent>

    <groupId>org.example</groupId>

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

    <version>1.0-SNAPSHOT</version>

    <properties>

        <maven.compiler.source>8</maven.compiler.source>

        <maven.compiler.target>8</maven.compiler.target>

        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>

    </properties>

    <dependencies>

        <dependency>

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

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

        </dependency>

        <dependency>

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

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

        </dependency>

        <dependency>

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

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

        </dependency>

    </dependencies>

</project>

2、创建MyLog注解

package org.example.annotaion;

import java.lang.annotation.ElementType;

import java.lang.annotation.Retention;

import java.lang.annotation.RetentionPolicy;

import java.lang.annotation.Target;

@Target(ElementType.METHOD)

@Retention(RetentionPolicy.RUNTIME)

public @interface MyLog {

    /**

     * 方法描述

     * @return

     */

    String desc() default "";

}

3、创建日志拦截器

package org.example.interceptor;

import org.example.annotaion.MyLog;

import org.springframework.web.method.HandlerMethod;

import org.springframework.web.servlet.ModelAndView;

import org.springframework.web.servlet.handler.HandlerInterceptorAdapter;

import javax.servlet.http.HttpServletRequest;

import javax.servlet.http.HttpServletResponse;

import java.lang.reflect.Method;

/**

 * TODO 自定义日志拦截器

 *

 * @author ss_419

 * @version 1.0

 * @date 2023/7/8 17:43

 */

public class MyLogInterceptor extends HandlerInterceptorAdapter {

    private static final ThreadLocal<Long> startTimeThreadLocal = new ThreadLocal<>();// 记录时间毫秒值

    /**

     * 执行之前

     * @param request

     * @param response

     * @param handler

     * @return

     * @throws Exception

     */

    @Override

    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {

        // 进行转换

        HandlerMethod handlerMethod = (HandlerMethod) handler;

        Method method = handlerMethod.getMethod();

        // 获取方法上的注解MyLog

        MyLog annotation = method.getAnnotation(MyLog.class);

        if(annotation != null){

            // 说明当前拦截到的方法上加入了MyLog注解

            long currentTimeMillis = System.currentTimeMillis();

            startTimeThreadLocal.set(currentTimeMillis);

        }

        return true;

    }

    /**

     * 执行之后

     * @param request

     * @param response

     * @param handler

     * @param modelAndView

     * @throws Exception

     */

    @Override

    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {

        HandlerMethod handlerMethod = (HandlerMethod) handler;

        Method method = handlerMethod.getMethod();

        // 获取方法上的注解MyLog

        MyLog annotation = method.getAnnotation(MyLog.class);

        if(annotation != null){

            // 说明当前拦截到的方法上加入了MyLog注解

            Long startTime = startTimeThreadLocal.get();

            long endTime = System.currentTimeMillis();

            long optTime =  endTime - startTime;

            String requestUri = request.getRequestURI();

            String methodName = method.getDeclaringClass().getName() + "."+

                                method.getName()+"()";

            String methodDesc = annotation.desc();

            System.out.println("请求uri："+requestUri);

            System.out.println("请求方法名："+methodName);

            System.out.println("方法描述："+methodDesc);

            System.out.println("方法执行时间："+optTime+"ms");

        }

        super.postHandle(request, response, handler, modelAndView);

    }

}

4、创建自动装配对象

package org.example.config;

import org.example.interceptor.MyLogInterceptor;

import org.springframework.context.annotation.Configuration;

import org.springframework.web.servlet.config.annotation.InterceptorRegistry;

import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

/**

 * TODO

 *

 * @author ss_419

 * @version 1.0

 * @date 2023/7/8 18:08

 */

@Configuration

public class MyLogAutoConfiguration implements WebMvcConfigurer {

    /**

     * 注册自定义日志拦截器

     * @param registry

     */

    @Override

    public void addInterceptors(InterceptorRegistry registry) {

        registry.addInterceptor(new MyLogInterceptor());

    }

}

5、在resources下创建META-INF，在该文件夹下创建spring.factories

该配置文件用于扫描自动装配类

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\

org.example.config.MyLogAutoConfiguration

2、使用

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

<?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>org.example</groupId>

    <artifactId>use-my-spring-boot-starter-demo</artifactId>

    <version>1.0-SNAPSHOT</version>

    <parent>

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

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

        <version>2.2.2.RELEASE</version>

        <relativePath/>

    </parent>

    <properties>

        <maven.compiler.source>8</maven.compiler.source>

        <maven.compiler.target>8</maven.compiler.target>

        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>

    </properties>

    <dependencies>

        <dependency>

            <groupId>org.example</groupId>

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

            <version>1.0-SNAPSHOT</version>

        </dependency>

        <dependency>

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

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

        </dependency>

        <dependency>

            <groupId>org.example</groupId>

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

            <version>1.0-SNAPSHOT</version>

        </dependency>

    </dependencies>

</project>

2、创建测试Controller

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

package org.example.controller;

import org.example.annotaion.MyLog;

import org.example.service.HelloService;

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.web.bind.annotation.GetMapping;

import org.springframework.web.bind.annotation.RequestMapping;

import org.springframework.web.bind.annotation.RestController;

/**

 * TODO

 *

 * @author ss_419

 * @version 1.0

 * @date 2023/7/8 14:36

 */

@RestController

@RequestMapping("/hello")

public class HelloController {

    @Autowired

    private HelloService helloService;

    @GetMapping("/sayHello")

    @MyLog(desc = "sayHello方法")

    public String sayHello() {

     return helloService.sayHello();

    }

}

3、测试

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

通用权限系统-Spring-Boot-Starter的更多相关文章

spring -boot s-tarter 详解
Starter POMs是可以包含到应用中的一个方便的依赖关系描述符集合.你可以获取所有Spring及相关技术的一站式服务,而不需要翻阅示例代码,拷贝粘贴大量的依赖描述符.例如,如果你想使用Sprin ...
SpringBoot 之Spring Boot Starter依赖包及作用
Spring Boot 之Spring Boot Starter依赖包及作用 spring-boot-starter 这是Spring Boot的核心启动器,包含了自动配置.日志和YAML. spri ...
Spring Boot Starter列表
转自:http://blog.sina.com.cn/s/blog_798f713f0102wiy5.html Spring Boot Starter 基本的一共有43种,具体如下: 1)spring ...
创建自己的Spring Boot Starter
抽取通用模块作为项目的一个spring boot starter.可参照mybatis的写法. IDEA创建Empty Project并添加如下2个module,一个基本maven模块,另一个引入sp ...
手把手教你手写一个最简单的 Spring Boot Starter
欢迎关注微信公众号:「Java之言」技术文章持续更新,请持续关注...... 第一时间学习最新技术文章领取最新技术学习资料视频最新互联网资讯和面试经验何为 Starter ? 想必大家都使用过 ...
Spring Boot Starter 和 ABP Module
Spring Boot 和 ABP 都是模块化的系统,分别是Java 和.NET 可以对比的框架.模块系统是就像乐高玩具一样,一块一块零散积木堆积起一个精彩的世界.每种积木的形状各不相同,功能各不相同 ...
三分钟实战手写Spring Boot Starter
1 背景在平时的开发中,开发的同学会把一些通用的方法,写成一个工具类,例如日期转换的,JSON转换的等等,方便业务后续调用,使代码更容易维护. 如果一些更常用的方法,例如鉴权的,加解密的等等,几乎每 ...
Spring Boot Starter 介绍
http://www.baeldung.com/spring-boot-starters 作者:baeldung 译者:http://oopsguy.com 1.概述依赖管理是任何复杂项目的关键部分 ...
Spring Boot (一): Spring Boot starter自定义
前些日子在公司接触了spring boot和spring cloud,有感于其大大简化了spring的配置过程,十分方便使用者快速构建项目,而且拥有丰富的starter供开发者使用.但是由于其自动化配 ...
Spring boot starter pom的依赖关系说明
Spring Boot 通过starter依赖为项目的依赖管理提供帮助.starter依赖起始就是特殊的maven依赖,利用了传递依赖解析,把常用库聚合在一起,组成了几个为特定功能而定制的依赖. sp ...

随机推荐

js开发规范
####################### 1.缩进 [强制] 使用 4 个空格做为一个缩进层级,不允许使用 2 个空格或 tab 字符. [强制] switch中缩进2个空格 [强制] 要求分 ...
Django笔记二十一之使用原生SQL查询数据库
本文首发于公众号:Hunter后端原文链接:Django笔记二十一之使用原生SQL查询数据库 Django 提供了两种方式来执行原生 SQL 代码. 一种是使用 raw() 函数,一种是使用 co ...
idea快捷键--增强for循环
增强for循环,用于遍历:数组或单列集合快捷键: 数组.for
【Mybatis Plus】
引入依赖 <dependencies> <dependency> <groupId>org.springframework.boot</groupId> ...
Solon v2.2.10 发布，助力信创国产化
Solon 是一个高效的 Java 应用开发框架:更快.更小.更简单.它不是 Spring.没有使用 Servlet.JavaEE 接口,是一个有自己接口标准的开放生态.可以为应用软件国产化提供支持, ...
Golang一日一库之logrus
前言之前一篇文章介绍了日志库zap https://www.cnblogs.com/zichliang/p/17311480.html 毋庸置疑,zap库无论是Golang在项目中还是生产中都极 ...
SpringCloud导入spring boot项目当作子模块微服务IDEA不识别子module问题
1.在父工程下面引入module. <modules> <module>study-design-mode</module> </modules> 2. ...
[Pytorch框架] 2.2 深度学习基础及数学原理
文章目录 2.2 深度学习基础及数学原理 2.2.1 监督学习和无监督学习 2.2.2 线性回归 (Linear Regreesion) 2.2.3 损失函数(Loss Function) nn.L1 ...
大话AI绘画技术原理与算法优化
引子博主很长一段时间都没有发文,确实是在忙一些技术研究. 如标题所示,本篇博文主要把近段时间的研究工作做一个review. 看过各种相关技术的公关文章,林林总总,水分很多. 也确实没有多少人能把一些 ...
查找命令 (which 、 find ）----grep 、 wc 和管道符，echo ，反引号 `
which命令通过which命令,查看所使用的一系列命令的程序文件存放在哪里 find命令按文件大小查找文件语法:find 起始路径 -size [(+,-)k,m,g ] •+.-表示 ...

通用权限系统-Spring-Boot-Starter

Spring-Boot-Starter

自定义Starter

1、创建

2、使用

1、创建

2、使用

通用权限系统-Spring-Boot-Starter的更多相关文章

随机推荐

热门专题