# phaeris

**Repository Path**: phaeris/Reminton

## Basic Information

- **Project Name**: phaeris
- **Description**: 「springboot2+jwt」搭建restful api 脚手架
- **Primary Language**: Java
- **License**: MIT
- **Default Branch**: SIT
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 9
- **Forks**: 1
- **Created**: 2017-04-07
- **Last Updated**: 2025-06-09

## Categories & Tags

**Categories**: restful

**Tags**: None

## README

# phaeris

#### 项目介绍
springboot restful 脚手架

#### 软件架构
| 描述| 框架|  
| :------| :------|  
| 核心框架| SpringBoot |  
| 数据访问层 | SpringData|  
| 无状态鉴权 | JWT|  
| 分布式session框架 | SpringSession|  
| 消息中间件 | ActiveMQ|  
| 数据库连接池 | HikariCP|  
| 日志分析 | ELK|
| 分布式调度器 | QUARTZ|  
| 应用监控 | SpringBootAdmin+SpringBootActuator|  
| 自定义云配置中心 | Nacos|  

#### 使用说明

1. aop  
    整合elasticsearch+logstash+kibana记录日志
2. jwt  
    使用jwt做无状态api认证并配合签名校验机制来保证接口安全（参考[guns-rest](https://gitee.com/stylefeng/guns)）。[^详情]
3. global exception  
    统一返回错误  
4. spring async(ThreadPoolTaskExecutor)  
    通过@Async(指定线程池名)来创建线程实现  
5. swagger  
    通过swagger做前后端API文档并测试  
6. spring session  
    通过spring session解决集群下统一session的问题  
7. 支付  
    整合收钱吧  
8. lombok  
    使用lombok插件，简化代码  
9. activemq  
    使用activemq作为消息中间件，支持topic和queue;支持failover，具体实现可自己选择
10. scheduled、cxf   
    单应用调度器、cxf-ws接口开发  
11. hikariCP  
    配置使用springboot2内置数据库连接池
12. quartz  
    使用quartz作为分布式定时任务，提供整套API  
13. spring actuator  
    使用springActuator动态修改日志级别,如需打开其他监控功能在配置文件配置即可，默认仅打开loggers  
14. redis  
    使用redis做缓存；sentinel redis集群等 
15. spring-boot-admin  
    使用springboot生态监控工具监控应用健康与邮件报警 
16. nacos  
    使用阿里巴巴nacos做自定义云配置中心 

#### 启动
1.mvn clean package -DskipTests

2.nohup java -jar $name-exec.jar >/dev/null 2>&1 & 

#### 需要安装

[elk](https://www.elastic.co/downloads)  
[redis](https://redis.io/download)  
[activemq](http://activemq.apache.org/download.html)  
[mysql](https://www.mysql.com/downloads/)  


#### 参与贡献

1. [wyh](https://gitee.com/wyhtoString)


#### 地址

1. [官方](https://gitee.com/wyhtoString/Reminton)

[^详情]: doc/接口认证与验签说明.md
[^start]: file/shell/start.sh