Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/houbb/lombok-ex
Java compile time annotation, lombok extension framework.（java 编译时注解框架，对 lombok 进行扩展）
https://github.com/houbb/lombok-ex
annotation aop asm ast compile-time-annotation ex extra jca jvm-sandbox lombok
Last synced: about 2 months ago
JSON representation
Java compile time annotation, lombok extension framework.（java 编译时注解框架，对 lombok 进行扩展）
- Host: GitHub
- URL: https://github.com/houbb/lombok-ex
- Owner: houbb
- License: apache-2.0
- Created: 2019-10-03T03:39:51.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-06-17T03:20:52.000Z (over 2 years ago)
- Last Synced: 2023-07-26T21:57:58.476Z (over 1 year ago)
- Topics: annotation, aop, asm, ast, compile-time-annotation, ex, extra, jca, jvm-sandbox, lombok
- Language: Java
- Homepage:
- Size: 94.7 KB
- Stars: 32
- Watchers: 2
- Forks: 22
- Open Issues: 4
-
Metadata Files:
- Readme: README-ENGLISH.md
- Changelog: CHANGE_LOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# lombok-ex
> [中文文档](README.md)
[lombok-ex](https://github.com/houbb/lombok-ex) is a compile-time annotation framework similar to lombok.
Mainly add some common tools that lombok does not implement, and you will use yourself.
There is no loss in annotation performance at compile time. One annotation does everything, no third-party dependencies.
[](http://mvnrepository.com/artifact/com.github.houbb/lombok-ex)
[](https://www.travis-ci.org/houbb/lombok-ex)
[](https://coveralls.io/github/houbb/lombok-ex?branch=master)
## Creative purpose
-Added missing annotations of lombok to facilitate daily development and use.
-The source code of lombok is basically unreadable, it should be encrypted.
-Provide a basis for improving the performance of other annotation-related frameworks, and consider replacing them with compile-time annotations later.
## Features
- `@Serial`
- `@Util`
- `@ToString`
- `@Sync`
- `@Modifiers`
## CHANGE LOG
[CHANGE LOG](CHANGE_LOG.md)
# Quick Start
## Require
jdk1.7+
maven 3.x+
- enable annotation process。
If you use editor，please checked【enable annotation process】
## maven import
```xml
com.github.houbb
lombok-ex
0.0.8
provided
```
- Gradle import
```
compile group: 'com.github.houbb', name: 'lombok-ex', version: '0.0.8'
```
# @Serial annotation
- User.java
We can use `@Serial` like this:
```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;
}
}
```
## compile
use maven command
```
$ mvn clean install
```
## result
see the User.class, content is as following：
```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 annotation
## usage
```java
@Util
public class StringUtil {
public static boolean isEmpty(final String string) {
return null == string || "".equals(string);
}
}
```
## result
```java
public final class StringUtil {
private StringUtil() {
}
public static boolean isEmpty(String string) {
return null == string || "".equals(string);
}
}
```
# @ToString annotation
## usage
```java
import com.github.houbb.lombok.ex.annotation.ToString;
@ToString
public class ToStringTest {
}
```
## result
ps: This is dependent on FastJson, you need import it by yourself.
```java
import com.alibaba.fastjson.JSON;
public class ToStringTest {
public ToStringTest() {
}
public String toString() {
return JSON.toJSONString(this);
}
}
```
## Config Type
`@ToString` can also config the toString() generate type.
### java code
```java
@ToString(ToStringType.CONCAT)
public class ToStringConcatTest {
private String name;
private int age;
private int[] ints;
}
```
### class result
```java
import java.util.Arrays;
public class ToStringConcatTest {
private String name;
private int age;
private int[] ints;
public ToStringConcatTest() {
}
public String toString() {
return "ToStringConcatTest{name=" + this.name + ", age=" + this.age + ", ints=" + Arrays.toString(this.ints) + "}";
}
}
```
# @Sync
## Usage
```java
@Sync
public void syncTest() {
System.out.println("sync");
}
```
## result
```java
public synchronized void syncTest() {
System.out.println("sync");
}
```
# @Modifiers
## Intro
You can modify the access level of classes, methods, and fields with `@Modifiers`.
There may be no particularly good application scenarios for the time being, depending on the user's own use.
Note: Do not engage in something that is difficult to understand, as easy as possible for users to understand.
## Usage
`@Modifiers` has appendMode attr，default is true。
If set to false, you can directly change the modifier to the one specified by the user.
```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");
}
}
```
## result
```java
public final class ModifiersTest {
private volatile int value;
public ModifiersTest() {
}
public static synchronized void syncTest() {
System.out.println("sync");
}
}
```
# Road-map
- [ ] Config and Optimize
- [ ] `@AutoLog` implements
- [ ] `@Equals` `@HashCode` `@EqualsAndHashCode` implements
- [ ] `@NotNull` for argument check, like [valid](https://github.com/houbb/valid)
- [ ] `@Async` async execute [async](https://github.com/houbb/async)
- [ ] [bean-mapping](https://github.com/houbb/bean-mapping), [sensitive](https://github.com/houbb/sensitive)
- [ ] AST basic framework
Idea: parse the text directly through AST, and then rebuild the class file through AST combined with jdk utils.