# JustStation

**Repository Path**: Verlif/JustStation

## Basic Information

- **Project Name**: JustStation
- **Description**: JustStation是一个基于Spring Boot的快速开发框架，包括了基础权限、文件、日志、参数检测等的常用功能，遵循COC原则，非侵入式开发
- **Primary Language**: Java
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 0
- **Created**: 2021-11-20
- **Last Updated**: 2022-05-30

## Categories & Tags

**Categories**: Uncategorized

**Tags**: SpringBoot, MySQL, MyBatis

## README

# JustStation

基于SpringBoot的开源框架，只包括JavaWeb框架，不包括前端页面与拓展业务实现。  
为了更方便的功能拓展、更好的维护管理与乱七八糟的需求服务。  
> **当前版本中的大部分功能以依赖的方式使用，所以亦可以当作这些组件的使用演示**

[Github主页](https://github.com/Verlif/JustStation) | [Github WIKI](https://github.com/Verlif/JustStation/wiki)
| [Gitee主页](https://gitee.com/Verlif/JustStation) | [Gitee WIKI](https://gitee.com/Verlif/JustStation/wikis/Home) 

~~WIKI上有比较详细的功能实现说明~~ 组件的使用请前往对应组件的Github页面

----

## 使用

*本框架是辅助型框架，所以需要拉取项目代码，在此代码基础上进行拓展开发*

1. `just-demo`子模块包括了大部分的功能使用演示。
2. 未来可能会出一个包括前端代码的例子，现在只能通过Swagger的文档页面进行功能试验。

* Java版本：1.8+
* Maven版本：3.6.0+
* 需要Lombok插件

----

## 特点

* 低侵入，大部分模块都通过注解或配置文件的方式进行使用，降低了代码量与维护难度
* 自由配置，大部分模块都提供了配置文件选项，可直接通过配置文件控制其中的功能细节。
* 环境分离，所有功能都通过接口自动注入的方式实现，便于使用Spring的方式进行环境分离。
* 数据库不相关，框架逻辑与数据库结构没有关系，需要登录与权限的功能只需要实现接口逻辑即可。
* 遵循COC原则，所有接口都有内置实现类，大部分功能也可以通过配置文件来关闭或启用。
* 低依赖，项目尽量使用spring组件或是Java内置实现，并提供拓展接口，方便自定义替换。

----

## 功能点

* 开放式登录，快速实现单点、互斥、共享等登录模式，密码、令牌等登录方式。
* （独立）权限配置，使用`@Perm`注解来标记接口权限。
* （独立）接口访问限制，可以在不使用中间件的方式下使用`@Limit`注解完成接口访问限制，例如限流。
* （独立）接口等幂性实现，过滤重复的请求，支持自定义判定。
* （独立）简单的数据脱敏，使用`@Sensitive`注解来标记目标属性，在返回值时自动脱敏。
* （独立）简单的文件管理，支持自定义文件域，功能包括上传、下载、导入、导出等。
* （独立）接口日志记录，使用`@LogIt`注解来标记需要记录的接口。
* 参数检测，使用`validation`进行参数校验，使用注解完成自动入参检测。
* （独立）组件式全局异常处理，通过实现`ExceptionHolder`来完成特定异常的全局处理。
* （独立）统一任务调度，定时任务与多线程任务都由`TaskServer`管理。定时任务组件化实现方式，可以在配置文件中配置允许名单与屏蔽名单。
* （独立）~~简单指令（默认关闭），通过`SimCommad`来编写自定义的简单指令。~~
* 接口屏蔽（默认关闭），当前版本可以直接通过配置文件的方式关闭指定API的访问（404）

----

## 技术选型

* 核心框架 - spring boot
* *~~持久层 - mybatis plus、druid~~（移至demo中）*
* 登录模式 - spring-security、token
* 安全相关 - spring-security、RSA加密
* 缓存实现 - 内存非持久化缓存、*~~Redis~~（移至demo中）*
* 日志记录 - logging-spring-boot-starter（默认log4j2）
* 调度任务 - task-spring-boot-starter
* 数据脱敏 - jackson-sensible
* 接口等幂性 - norepeat-spring-boot-starter
* 参数校验 - spring-validation
* API文档 - springfox3、knife4j

----

## 开发ING

* 示例项目 - 博客系统（暂定）
* 代码与框架的规范性调整（持续）
* 将每个功能模块独立为单个依赖  
  [√] [全局异常处理](https://github.com/Verlif/exception-spring-boot-starter)  
  [√] [指令生成器](https://github.com/Verlif/just-simmand)  
  [√] [任务调度服务](https://github.com/Verlif/task-spring-boot-starter)  
  [√] [接口访问限制](https://github.com/Verlif/limit-spring-boot-starter)  
  [√] [接口等幂性实现](https://github.com/Verlif/norepeat-spring-boot-starter)  
  [√] [日志服务](https://github.com/Verlif/logging-spring-boot-starter)  
  [√] [文件管理系统](https://github.com/Verlif/file-spring-boot-starter)  
  [√] [Jackson序列化脱敏](https://github.com/jackson-sensible)
* 拓展文件配置，在不影响性能的情况下拓展每个模块的可配置项（持续）

----

## 测试

项目中编写了一些测试接口与指令，方便测试与开发 项目中集成了springfox3与knife4j，可以通过 <http://127.0.0.1:8888/doc.html> 访问接口文档

----

> 注：因为我英文不好，所以这个Wiki是中文的  
> 注：我也不会写Wiki