Lombok 依赖实现自动setterangetter构造方法

55 篇文章 0 订阅


Lombok是一款非常实用Java第三方工具,它可以帮助开发人员消除Java的冗长代码,尤其是对于简单的Java对象(POJO)

Lombok的使用

安装导入

  1. IDE中安装Lombok插件,File → Settings → Plugins,输入“lombok”,选中“install”进行安装即可,安装后需重启IDEA才能运行
    在这里插入图片描述
  2. 导入相关依赖,Lombok 支持使用多重构建工具进行导入依赖,目前主要支持maven、gardle、ant等均支持。如使用maven导入方式如下
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <version>1.18.12</version>
        <scope>provided</scope>
    </dependency>
    

基本使用

Lombok精简代码的方式主要是通过注解来实现,其中常用的有@Data、@Getter/@Setter、@Builder、@NonNull等。

如使用@Data注解,这样一来,这个实体类中的属性就不需要get,set和toString方法了,这对于POJO类十分有用,即可简单的定义一个Java Bean:

import lombok.Data;
 
@Data
public class User {
    private String id;
    private String age;
    private String name;
    private String job;
}
@Date:加在类上,相当于同时使用了@ToString@EqualsAndHashCode@Getter@Setter@RequiredArgsConstrutor这些注解
@AllArgsConstructor:类上,可以生成含实体类全参数的构造方法
@NoArgsConstructor:类上,可以生成无参构造方法
@RequiredArgsConstructor:类上,配合@NonNull注解使用,生成指定参数的构造方法。比如在age属性前面加@NonNull注解,则User生成需要age参数的构造方法

@Getter:类上,可以生成实体类所有属性的getter方法
@Setter:类上,可以生成实体类所有属性的setter方法
	生成的getter遵循布尔属性的约定。例如:boolean类型的sex,getter方法为isSex而不是getSex
	在使用该注解时,会默认生成一个无参构造。和对应的getterhe setter方法
	该注解也可以使用在单个属性上,会默认生成一个无参构造
	
@ToString:类上,调用toString()方法,可以输出实体类中所有属性的值
@EqualsAndHashCode:在类上,该注解在类级别注释会同时生成equals和hashCode

@NotNull:属性上,该注解用于属的非空检查,当放在setter方法的字段上,将生成一个空检查,如果为空,则抛出NullPointerException
	该注解会默认生成一个无参构造
	
@Value:类上,会生成含所有参数的构造方法,get 方法,此外还提供了equals、hashCode、toString 方法
	注意:没有setter

@Slf4j:打印日志
	================================简化日志开发===================================
	@Slf4j
	@RestController
	public class HelloController {
	    @RequestMapping("/hello")
	    public String handle01(@RequestParam("name") String name){
	        
	        log.info("请求进来了....");
	        
	        return "Hello, Spring Boot 2!"+"你好:"+name;
	    }
	}	

好处和坏处

好处

使用@Data注解大大减少了代码量,使代码非常简洁,这也是很多开发者热衷于使用Lombok的主要原因。

  • 减少模板代码:lombok处理get,set,toString,hash,equal等方法,大量的模板代码进行封装,减少重复代码,当增加新属性的时候,以上方法都不需要再重新编写
  • 增强代码可读性:专注于类的属性定义,不需要再去为排版浪费时间
  • 减少代码维护:新增属性的时候,会减少非常多的代码维护工作

坏处

  • Lombok插件的使用,要求开发者一定要在IDE中安装对应的插件。不仅自己要安装,任何和你协同开发的人都要安装。如果有谁未安装插件的话,使用IDE打开一个基于Lombok的项目的话会提示找不到方法等错误,导致项目编译失败。

  • Lombok确实可以帮忙减少很多代码,因为Lombok会帮忙自动生成很多代码。但是,这些代码是要在编译阶段才会生成的,所以在开发的过程中,其实很多代码其实是缺失的。这就给代码调试带来一定的问题,我们想要知道某个类中的某个属性的getter方法都被哪些类引用的话,就没那么简单了。

  • 可能会破坏封装性举个简单的例子,我们定义一个购物车类:

    @Data
    public class ShoppingCart { 
        //商品数目
        private int itemsCount; 
        //总价格
        private double totalPrice; 
        //商品明细
        private List items = new ArrayList<>();
    }
    

我们知道,购物车中商品数目、商品明细以及总价格三者之前其实是有关联关系的,如果需要修改的话是要一起修改的。

但是,我们使用了Lombok的@Data注解,对于itemsCount 和 totalPrice这两个属性,虽然我们将它们定义成 private 类型,但是提供了 public 的 getter、setter 方法。

外部可以通过 setter 方法随意地修改这两个属性的值,我们可以随意调用 setter 方法,来重新设置 itemsCount、totalPrice 属性的值,这也会导致其跟 items 属性的值不一致。

而面向对象封装的定义是:通过访问权限控制,隐藏内部数据,外部仅能通过类提供的有限的接口访问、修改内部数据。所以,暴露不应该暴露的 setter 方法,明显违反了面向对象的封装特性。

好的做法应该是不提供getter/setter,而是只提供一个public的addItem方法,同时取修改itemsCount、totalPrice以及items三个属性。

问题

解决lombok注解不生效

首先lombok仅仅在maven导入依赖是不够的,还要进行安装。
Maven中lombok依赖

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.18.10</version>
    <scope>provided</scope>
</dependency>

在idea中File—>setting中找到lombok可以直接install安装,提示重启后配置完pom.xml就可以使用lombok了
在这里插入图片描述

  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值