您现在的位置是: 首页> SpringBoot框架入门 > 正文

二.SpringBoot配置lombok

时间: 2022-02-15 23:23:02 来源:网络 作者:自由 分类:SpringBoot框架入门
简介:

Lombok想要解决了的是在我们实体Bean中大量的Getter/Setter方法,以及toString, hashCode等可能不会用到,但是某些时候仍然需要复写,以期方便使用的方法;在使用Lombok之后,将由其来自动帮你实现代码生成,注意,其是 在运行过程中,帮你自动生成的 。就是说,将极大减少你的代码总量。

简介:

    Lombok想要解决了的是在我们实体Bean中大量的Getter/Setter方法,以及toString, hashCode等可能不会用到,但是某些时候仍然需要复写,以期方便使用的方法;在使用Lombok之后,将由其来自动帮你实现代码生成,注意,其是 在运行过程中,帮你自动生成的 。就是说,将极大减少你的代码总量。提高代码编写的效率。消除模板代码getter、setter、构造器、toString()、equals()便捷的生成比较复杂的代码,例如一个entity要转化成构建器模式的形式,只需要一个注解。
官方地址:https://projectlombok.org/    
 

一.SpringBoot配置lombok

1.在pom.xml中添加引入包

<!-- lombok-->
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <optional>true</optional>
</dependency>

2.安装lombok插件

选择”文件——》“设置打开弹框。选择插件,在文本框中输入lombok安装即可

3.lombok最常用的就是简化get和set方法,我们建一个实体类查看效果

package com.tms.tblog.entity;

import com.baomidou.mybatisplus.annotation.*;
import com.fasterxml.jackson.annotation.JsonFormat;
import lombok.Data;
import java.time.LocalDateTime;

/**
 * 账号表
 * @author lcj
 * @since 2021-12-31
 */
@Data
public class Account {
    private static final long serialVersionUID = 1L;
    @TableField(fill = FieldFill.INSERT)
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    private LocalDateTime createTime;
    @TableId(value = "account_id", type = IdType.AUTO)
    private Long accountId;
    private Long roleId;
    @TableField(exist = false)
    private String roleName;
    private String username;
    private String password;
    private String salt;
    private String realName;
    private String sex;
    private String email;
    @TableField(fill = FieldFill.UPDATE)
    private LocalDateTime modifiedTime;
    @TableField(fill = FieldFill.INSERT)
    private Long createAccountId;
    @TableField(fill = FieldFill.UPDATE)
    private Long modifiedAccountId;
    @TableLogic
    private Integer deleted;
}

4.在Controller编写实体的时候就可以点出来对应的get和set方法了

二.lombok详细注解介绍

@Data:注解在类上,相当于同时使用了@Setter+@Getter+@EqualsAndHashCode+@NoArgsConstructor+@ToString,对于实体类比较实用
@NonNull:注解在属性/方法参数上,如果方法内对该参数进行是否为空的校验,如果为null值,则抛出NullPointerException异常
@Cleanup:自动管理资源,用在局部变量之前,在当前变量范围内即将执行完毕退出之前会自动清理资源,自动生成try-finally这样的代码来关闭流
@Getter/@Setter:注解在属性上,自动生成生成setter/getter方法,final变量不包含,还可以指定访问范围
@ToString:注解在类上,可以自动覆写toString方法,当然还可以加其他参数,例如@ToString(exclude=”id”)排除id属性,或者@ToString(callSuper=true, includeFieldNames=true)调用父类的toString方法,包含所有属性
@EqualsAndHashCode:注解在类上,自动生成equals()方法和hashCode方法
@NoArgsConstructor:注解在类上,自动生成空参构造方法
@AllArgsConstructor:注解在类上,自动生成全部参数构造方法
@RequiredArgsConstructor:注解在类上,将标记为@NoNull的属性自动生成构造方法(如果运行中标记为@NoNull的属性为null,会抛出空指针异常)
@Data:注解在类上,相当于同时使用了@ToString、@EqualsAndHashCode、@Getter、@Setter和@RequiredArgsConstrutor这些注解,对于POJO类十分有用
@Value:注解在类上,是@Data的不可变形式, 两个主要区别就是如果变量不加@NonFinal ,@Value会给所有的弄成final的。当然如果是final的话,就没有set方法了。用于注解final类
@Builder:用在类、构造器、方法上,为你提供复杂的builder APIs,让你可以像如下方式一样调用Person.builder().name("name").city("shanghai").build();更多说明参考Builder
@SneakyThrows:自动抛受检异常,而无需显式在方法上使用throws语句。自动调用close方法关闭资源。
@Synchronized:用在方法上,将方法声明为同步的,并自动加锁,而锁对象是一个私有的属性$lock或$LOCK,而java中的synchronized关键字锁对象是this,锁在this或者自己的类对象上存在副作用,就是你不能阻止非受控代码去锁this或者类对象,这可能会导致竞争条件或者其它线程错误
@Getter(lazy=true):可以替代经典的Double Check Lock样板代码
@Log:注解在类上,根据不同的注解生成不同类型的log对象,但是实例名称都是log,有六种可选实现类
@CommonsLog Creates log = org.apache.commons.logging.LogFactory.getLog(LogExample.class);
@Log Creates log = java.util.logging.Logger.getLogger(LogExample.class.getName());
@Log4j Creates log = org.apache.log4j.Logger.getLogger(LogExample.class);
@Log4j2 Creates log = org.apache.logging.log4j.LogManager.getLogger(LogExample.class);
@Slf4j Creates log = org.slf4j.LoggerFactory.getLogger(LogExample.class);
@XSlf4j Creates log = org.slf4j.ext.XLoggerFactory.getXLogger(LogExample.class);

 

标签:java框架

文章声明
版权声明:本文为作者原创,仅用于本站访客学习、研究和交流目的,未经授权禁止转载
联系 作者

一个90后草根站长!13年入行。一直潜心研究技术,一边工作一边积累经验,分享一些个人后端技术(java、python、c#、php等),以及前端相关等心得。

关注 公众号