lombok-ex 编译时注解框架，性能完爆 AOP
lombok-ex 编译时注解框架，性能完爆 AOP
# lombok-ex
[lombok-ex](https://github.com/houbb/lombok-ex) 是一款类似于 lombok 的编译时注解框架。
主要补充一些 lombok 没有实现，且自己会用到的常见工具。
编译时注解**性能无任何损失**，一个注解搞定一切，无三方依赖。
## 创作目的
- 补充 lombok 缺失的注解，便于日常开发使用。
- lombok 的源码基本不可读，应该是加密处理了。
- 为其他注解相关框架提升性能提供基础，后期考虑替换为编译时注解。
## 特性
- `@Serial` 序列化
- `@Util` 工具类
- `@ToString` toString
- `@Sync` 同步
- `@Modifiers` 修饰符
## 变更日志
[变更日志](CHANGE_LOG.md)
# 快速开始
## 准备工作
jdk1.7+
maven 3.x+
- 编译器启用编译时注解功能。
如 idea 启用编译时注解，勾选【enable annotation process】
## maven 引入
```xml
<dependency>
<groupId>com.github.houbb</groupId>
<artifactId>lombok-ex</artifactId>
<version>0.0.7</version>
<scope>provided</scope>
</dependency>
```
- Gradle 引入方式
```
compile group: 'com.github.houbb', name: 'lombok-ex', version: '0.0.7'
```
# @Serial 注解
- User.java
我们定义一个简单的 pojo，使用 `@Serial`
```java
package com.github.houbb.lombok.test.model;
import com.github.houbb.lombok.ex.annotation.Serial;
@Serial
public class User {
private String name;
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
}
```
## 编译
直接使用 maven 命令编译
```
$ mvn clean install
```
## 编译结果
查看对应的 User.class 文件，内容如下：
```java
package com.github.houbb.lombok.test.model;
import java.io.Serializable;
public class User implements Serializable {
private static final Long serialVersionUID = 1L;
private String name;
public User() {
}
public String getName() {
return this.name;
}
public void setName(String name) {
this.name = name;
}
}
```
# @Util 注解
## 注解使用
```java
@Util
public class StringUtil {
public static boolean isEmpty(final String string) {
return null == string || "".equals(string);
}
}
```
## 效果
```java
public final class StringUtil {
private StringUtil() {
}
public static boolean isEmpty(String string) {
return null == string || "".equals(string);
}
}
```
# @ToString 注解
## 简介
`@ToString` 注解在类上使用，可以默认生成 toString() 方法
例子:
```java
import com.github.houbb.lombok.ex.annotation.ToString;
@ToString
public class ToStringTest {
}
```
## 效果
编译后的 class 文件信息：
ps: 此处依赖 FastJSON，请自行引入。
```java
import com.alibaba.fastjson.JSON;
public class ToStringTest {
public ToStringTest() {
}
public String toString() {
return JSON.toJSONString(this);
}
}
```
# @Sync 注解
## 使用
直接指定在方法上。
```java
@Sync
public void syncTest() {
System.out.println("sync");
}
```
## 效果
```java
public synchronized void syncTest() {
System.out.println("sync");
}
```
# @Modifiers 注解
## 说明
`@Modifiers` 可修改类、方法、字段的访问级别。
暂时可能没有特别好的应用场景，取决于用户自己的使用。
注意：不要搞一些难以理解的东西，尽可能便于使用者理解。
## 使用方式
`@Modifiers` 还有一个 appendMode 属性，默认为 true。
如果设置为 false，可以直接将修饰符改为用户指定的。
```java
import com.github.houbb.lombok.ex.annotation.Modifiers;
import com.github.houbb.lombok.ex.constant.Flags;
@Modifiers(Flags.FINAL)
public class ModifiersTest {
@Modifiers(Flags.VOLATILE)
private int value;
@Modifiers(Flags.SYNCHRONIZED)
public static void syncTest() {
System.out.println("sync");
}
}
```
## 效果
```java
public final class ModifiersTest {
private volatile int value;
public ModifiersTest() {
}
public static synchronized void syncTest() {
System.out.println("sync");
}
}
```
# 开源地址
> [https://github.com/houbb/lombok-ex](https://github.com/houbb/lombok-ex)
# 后期 Road-map
- [ ] 对于注解的开关配置以及编译优化
- [ ] `@AutoLog` 实现完善
- [ ] `@Equals` `@HashCode` `@EqualsAndHashCode` 等内置方法重载
- [ ] `@NotNull` 参数校验，可以单独一个项目 [valid](https://github.com/houbb/valid)
- [ ] `@Async` 异步执行 [async](https://github.com/houbb/async)
- [ ] [bean-mapping](https://github.com/houbb/bean-mapping), [sensitive](https://github.com/houbb/sensitive) 等优化
- [ ] AST 基础框架
思路：通过 AST 直接解析文本，然后通过 AST 结合 jdk utils 重新构建 class 文件。
# 原文链接
扫码关注一波~
