likes
comments
collection
share

一篇文章教你学会如何通过SpringBoot AOP实现自定义注解功能,来完成MP创建时间的自动填充、MP分页插件的配置

作者站长头像
站长
· 阅读数 15

前言

在我们编写springcloud微服务项目中我们会发现许多服务中需要进行对各种技术的重复配置,例如对redis的序列化配置,mybatisplus的自动填充策略和分页插件配置,对验证对象属性合法等,这篇文章我就对这两个配置以自定义注解的方式实现。

在使用aop实现之前,我们最好要先学习一下什么是aop,了解aop的思想。

这里想要大概了解aop的可以查看知乎上的一篇文章。 # Spring的面向切面编程(AOP)

一、自定义注解的作用

自定义注解的主要作用就是为了减少过滤器、拦截器、配置文件等需求的编写,增强代码的复用性,使用自定义注解我们就可以只需一个注解完成这些需求的实现。

二、自定义注解的实现

1.引入依赖

实现自定义注解我们需要添加springboot aop的依赖包, 由于要实现mp的功能我们也需要导入mp的依赖。 代码如下:

<dependency>
		<groupId>com.baomidou</groupId>
		<artifactId>mybatis-plus-boot-starter</artifactId>
</dependency>
 
<dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-aop</artifactId>
        <version>2.2.2.RELEASE</version>
</dependency>

2.代码实现

因为是在微服务中使用自定义注解,所以需要把自定义注解的实现写在公共模块中,以便其他服务进行调用。

1.annotation层和config层创建(名字任意)

一篇文章教你学会如何通过SpringBoot AOP实现自定义注解功能,来完成MP创建时间的自动填充、MP分页插件的配置

2.创建注解类(在创建类那边查看)

一篇文章教你学会如何通过SpringBoot AOP实现自定义注解功能,来完成MP创建时间的自动填充、MP分页插件的配置

创建成功后如下

一篇文章教你学会如何通过SpringBoot AOP实现自定义注解功能,来完成MP创建时间的自动填充、MP分页插件的配置

3.在注解类中添加注解

@Target({ElementType.TYPE}) 注解,其中的参数是该自定义注解出现的位置,例如类、字段、方法、接口上等。

@Retention({RetentionPolicy.Runtime}) 注解,是设置该注解什么时候被保留。

@Documented注解,注解是否将包含在JavaDoc中,若包含则成为公共接口的一部分。

@Import注解,是我用来从config层导入代码使用。

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Import(MyMetaObjectHandler.class)
public @interface EnableAutofill
{
}

4.配置文件编写

自动填充

@Slf4j
@Component
public class MyMetaObjectHandler implements MetaObjectHandler
{
    /**
     * 插入时的填充策略
     */
    @Override
    public void insertFill(MetaObject metaObject)
    {
        log.info("start insert fill.....");
        this.setFieldValByName("createTime", new Timestamp(System.currentTimeMillis()), metaObject);
    }
 
    /**
     * 更新时的填充策略
     */
    @Override
    public void updateFill(MetaObject metaObject)
    {
        log.info("start update fill.....");
        this.setFieldValByName("updateTime", new Timestamp(System.currentTimeMillis()), metaObject);
    }
}

分页插件

@EnableAutofill
@EnableMybatisPlusIPage
public class TestApplication {
    public static void main(String[] args) {
        SpringApplication.run(GoodsApplication.class);
    }
}

5.自定义注解使用

@EnableAutofill
@EnableMybatisPlusIPage
public class TestApplication {
    public static void main(String[] args) {
        SpringApplication.run(GoodsApplication.class);
    }
}

总结

以上就是大学牲的我在微服务项目中通过springboot aop实现自定义注解的步骤,若有什么不足请大家细心指出。