# qg-spring-boot-starter

**Repository Path**: LevelCoder/qg-spring-boot-starter

## Basic Information

- **Project Name**: qg-spring-boot-starter
- **Description**: 一个自定义的starter库，用于封装一些开发中的通用功能，目前包括认证模块、日志记录模块、knife4j日志、参数校验模块。
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 2
- **Created**: 2024-09-29
- **Last Updated**: 2024-09-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# qg-spring-boot-starter-v1

## 项目介绍

本项目主要用于封装项目中的通用功能，提高代码的复用性，目前封装了用户登录认证、knife4j、日志记录、参数校验等模块。各个模块的具体使用方法在模块内的README.md文件内。

## qg-auth-spring-boot-starter

### 模块介绍

模块为认证模块，封装了用户认证功能，导入该模块，只需通过简单的配置即可进行自动认证，使用者只需提供登录接口，完成登录后讲用户信息通过提供的工具类设置用户信息`WebContextUtil.setUser()`后，后续请求即可通过`WebContextUtil.getUser()`获取用户信息。

**模块实现**

模块目前实现了以下四种认证方式

- cookie session
- 基于redis的token
- jwt
- 基于redis的jwt

四种实现方式对于使用者无感知，使用者只需简单配置即可使用。

## qg-base-spring-boot-starter

其他模块的基础依赖模块以及一些工具类(现在主要是用于批量导入数据的工具类)

## qg-knife4j-spring-boot-starter

### 模块介绍

本模块是对knife4j文档的集成封装，使用者导入该模块，通过配置相应配置，即可在项目中使用knife4j文档，无需编写配置代码，提高代码复用性，可移植性高。

## qg-log-spring-boot-starter

### 模块介绍

本模块是对日志记录的封装，导入本模块后，可对指定接口增加日志注解`@SysLog`,增加后，会自动收集接口相关日志，收集完成后会通过spring的事件监听机制发布，使用者可通过配置监听类监听获取日志类后进行后续操作（例如保存到数据库等等），本模块同时也提供了日志类对应的**sql文件**。

### 模块实现

模块通过自定义注解加aop实现对接口日志信息的收集，并将其封装为日志类，再通过`Spring`的事件监听发布机制将日志类交由使用者处理，同时使用自定义注解`@EnableLogRecord`进行日志收集的是否启用，增加了代码的灵活性。

## qg-validate-spring-boot-starter

### 模块介绍