Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ifinal-io/final-annotation
定义基础的注释与接口
https://github.com/ifinal-io/final-annotation
cache query redis sharding
Last synced: about 2 months ago
JSON representation
定义基础的注释与接口
- Host: GitHub
- URL: https://github.com/ifinal-io/final-annotation
- Owner: ifinal-io
- License: apache-2.0
- Created: 2021-03-18T03:44:42.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-07-14T08:23:14.000Z (6 months ago)
- Last Synced: 2024-11-15T03:06:30.079Z (2 months ago)
- Topics: cache, query, redis, sharding
- Language: Java
- Homepage:
- Size: 912 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Final Annotation
[](http://www.apache.org/licenses/LICENSE-2.0.html)
`Final Annotation`定义基础的注释与接口。
## Final Annotation Core
`Final Annotation Core`定义了大量的超接口和注释，用于标记标记和区分元素（类、方法或属性）在项目中所扮演的角色。
如：
* **IEnum**：用于枚举的`IEnum`接口，可实现Json序列化增强及自定义数据映射。
* **IEntity**：用于实体类的`IEntity`接口，可实现ORM映射及通用的`CRUD`数据操作。
* **IException**: 用于异常的`IException`接口，可用于区分系统异常和业务异常，从而进行全局的异常处理。
* **IQuery**：用于查询的`IQuery`接口，可用于定义统一的查询规则。
* **IResult**：用于结果的`IResult`接口，可实现统一的结果集处理。
* **@Default**: 用于标记元素含有（或是）**默认**值，不需要框架进行处理。如数据的默认值。
* **@Final**：用于标记元素是**终态**，不应该被修改，如数据库的主键ID和创建时间。
* **@Transient**: 用于票房元素是**短暂**的，不需要被处理。
## Final Annotation Data
`Final Annotation Data`为`ORM`的定义了大量的注解。
如：
* **@Table**：用于指定实体类与数据库表的映射关系。
* **@Column**：用于指定实体类属性与数据库列的映射关系。
> 一个实体类应有实现`IEntity`接口，或继承自`AbsEntity`。
## Final Annotation Cache
`Final Annotation Cache`定义了切面缓存注释，使用`Redis`做为缓存存储，支持`Value`和`Hash`等数据结构。
可以为应用快速添加缓存功能，减少大量模板代码。
```java
public interface UserService {
@Cacheable(key = "#{#id}")
User findById(Long id);
}
```
## Final Annotation Query
`Final Annotation Query`提供了丰富的查询条件(`Criterion`)和更新操作(`Update`)。
### Query
**Final Annotation Query**提供**编码**和**注解**两种方式来构建查询条件。
如当需要构建以下查询条件时：
```sql
WHERE name = #{value} AND age BETWEEN #{min} AND #{max}
```
* 编码
```java
new Query().where(
name.eq("name"),
age.between(min,max)
);
```
* 注解
```java
public class MyQuery implements IQuery {
@Equal
private String name;
@Between
private BetweenValue age;
//setter and getter
//...
}
```
### Update
`Update`支持常用的数据设置及数学运算，如：
```java
// UPDATE table SET name = #{value},version = version + 1;
new Update().set("name","value").incr("version");
```
也添加了对`Json`数据列的支持：
```java
// UPDATE table SET json = JSON_SET(json,path,value);
new Update().jsonSet("json",);
// UPDATE table SET json = JSON_INSERT(json,path,value);
new Update().jsonInsert("json",);
// UPDATE table SET json = JSON_REPLACE(json,path,value);
new Update().jsonReplace("json",);
// UPDATE table SET json = JSON_REMOVE(json,paths);
new Update().jsonRemove("json",paths);
```
> **注意**`path`的格式为要以`$开头`。