# source

**Repository Path**: joesupper/source

## Basic Information

- **Project Name**: source
- **Description**: springboot api 项目快速开始的源头；集成了JPA，JWT，Dubbo，Redis；并提供了基础实体，树实体的通用API能力；支持分布式部署，容器自带负载均衡；实现了文件的统一处理，单机项目也可用；以注解形式，实现了权限的管控及整理，在实现业务的时候，就把权限定义好，再也不用维护权限的实体表；实现了单点登录；
- **Primary Language**: Java
- **License**: AGPL-3.0
- **Default Branch**: master
- **Homepage**: https://gitee.com/joesupper/source
- **GVP Project**: No

## Statistics

- **Stars**: 5
- **Forks**: 0
- **Created**: 2020-09-07
- **Last Updated**: 2026-02-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# source

#### 介绍

springboot api 项目快速开始的源头；

集成了SpringBoot，Swagger，JPA，JWT，Dubbo，Redis；

并提供了基础实体，树实体的通用API能力；

支持分布式部署，容器自带负载均衡；

实现了文件的统一处理，单机项目也可用；

以注解形式，实现了权限的管控及整理，在实现业务的时候，就把权限定义好，再也不用维护权限的实体表；

实现了单点登录；

开箱即用的DEMO地址：https://gitee.com/joesupper/server-spring-boot-template.git

#### 功能点说明

1. 对象支持JSON（对象或数组）属性，支持数据库JSON类型字段，继承JsonArrayType & JsonObjectType即可
2. RestApi支持返回内容加密，前端解密，具体方式见：NerveNetsResponseBodyAdvice
3. @JsonIgnoreEnv("env") 支持不同环境对象的某些字段不返回
4. @JsonSimplify 支持对象中某个外关联对象的返回的JSON结构简化或自定义
5. @EntityNotNull 提交参数时支持验证数据库对象是否为空
6. @Unique 支持判断提交数组的重复
7. @RedisAsyncLocker 支持Redis同步锁
8. @SysLog 支持全局日志
9. Swagger2Configuration 支持不同环境下是否开启接口文档
10. RedisCacheConfig 自定义Redis缓存结构，简化，支持过期时间。
11. 定义了基本的DomainObject和TreeEntityDomainObject，使用SnowFlakeId，可支持分布式下ID唯一
12. RedisMultiPointLocker实现了代码块不同方法内的同步锁
13. 封装了基础的MailService，配置好邮箱地址，线上产生的BUG直接通知到邮箱
14. 封装了基本的WebSocketService，可独立实现WebSocket节点
15. 封装了基本的BaseService，支持常规单个及批量查询，统一基础变量查询，支持对象中部分字段查询，且可查询直接返回自定义对象；还支持常规函数操作@SqlFun(sum、avg、max、min、count、countDistinct)
16. 封装了基本的TreeService，支持常规树操作，可自定义树结构
17. 以RestApiController的方法体作为载体，以注解方式，来配置权限，不用维护权限的实体表，避免产生人为误差
18. @ProhibitDuplicateRequest 一个客户端请求某个接口，在同一时间内，只能请求成功一次，并可配置锁定时间周期，比如每5分钟只能请求一次。

#### 安装教程

1. git clone https://gitee.com/joesupper/source.git
2. mvn install
3. <code>`<dependency>`<br>`<groupId>com.nervenets</groupId>`<br>`<artifactId>source</artifactId>`<br>`<version>1.0</version>`<br>`</dependency>`</code>

#### 使用说明

相关功能配置，可先查看ApplicationProperties

#### 参与贡献

#### 成都云汀科技有限公司提供