From b3356ad7e1980aff4385597e63e253eb1bbc7a91 Mon Sep 17 00:00:00 2001 From: haoqiong liu Date: Wed, 23 Sep 2020 18:16:23 +0800 Subject: [PATCH] =?UTF-8?q?=E6=9B=B4=E6=96=B0=E7=89=88=E6=9C=AC=EF=BC=8C?= =?UTF-8?q?=E7=BC=96=E5=86=99readme?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 51 +++++++------------ pom.xml | 2 +- .../com/common/base/config/SwaggerConfig.java | 4 +- 3 files changed, 23 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index ec0fe2f..485223a 100644 --- a/README.md +++ b/README.md @@ -1,39 +1,26 @@ -# common +# 基础包依赖及框架配置 #### 介绍 -{**以下是码云平台说明,您可以替换此简介** -码云是 OSCHINA 推出的基于 Git 的代码托管平台(同时支持 SVN)。专为开发者提供稳定、高效、安全的云端软件开发协作平台 -无论是个人、团队、或是企业,都能够用码云实现代码托管、项目管理、协作开发。企业项目请看 [https://gitee.com/enterprises](https://gitee.com/enterprises)} +基础包,对工具类及框架代码进行封装 -#### 软件架构 -软件架构说明 +#### 功能 +1. 封装Shiro权限部分,通过接口继承即可 +2. 对SwaggerUI部分封装,可通过yml文件进行配置 +3. 对Druid连接池部分进行封装,可通过yml文件进行配置 +4. 提供封装VO返回结果 +5. 提供PageHelper方法封装 +6. 将pageNum,pageSize,order,sort封装成对象,并提供是否包含排序校验,提供sql拼装校验 +7. 异常统一封装 +8. 通用mapper封装 +9. 接口参数日志封装,可通过yml文件进行配置 +10. redis工具类封装,可通过yml文件进行配置 +11. Spring上下文工具类封装 +12. 加密工具类封装 +13. 日期工具类封装 #### 安装教程 -1. xxxx -2. xxxx -3. xxxx - -#### 使用说明 - -1. xxxx -2. xxxx -3. xxxx - -#### 参与贡献 - -1. Fork 本仓库 -2. 新建 Feat_xxx 分支 -3. 提交代码 -4. 新建 Pull Request - - -#### 码云特技 - -1. 使用 Readme\_XXX.md 来支持不同的语言,例如 Readme\_en.md, Readme\_zh.md -2. 码云官方博客 [blog.gitee.com](https://blog.gitee.com) -3. 你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解码云上的优秀开源项目 -4. [GVP](https://gitee.com/gvp) 全称是码云最有价值开源项目,是码云综合评定出的优秀开源项目 -5. 码云官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help) -6. 码云封面人物是一档用来展示码云会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/) +1. 拉取指定分支代码 +2. 执行``mvn install`` +3. 刷新其他项目maven依赖 diff --git a/pom.xml b/pom.xml index fb22635..54178d9 100644 --- a/pom.xml +++ b/pom.xml @@ -10,7 +10,7 @@ com.common.base base - 0.0.1-COMMON + 1.0.1-COMMON jar common-base 基础包 diff --git a/src/main/java/com/common/base/config/SwaggerConfig.java b/src/main/java/com/common/base/config/SwaggerConfig.java index 4534997..b48203d 100644 --- a/src/main/java/com/common/base/config/SwaggerConfig.java +++ b/src/main/java/com/common/base/config/SwaggerConfig.java @@ -3,12 +3,14 @@ package com.common.base.config; import ch.qos.logback.classic.spi.ClassPackagingData; import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j; import com.github.xiaoymin.knife4j.spring.filter.SecurityBasicAuthFilter; +import io.swagger.annotations.Api; import org.springframework.beans.factory.annotation.Value; import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.boot.web.servlet.FilterRegistrationBean; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.Import; +import org.springframework.web.bind.annotation.RestController; import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry; import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport; import springfox.bean.validators.configuration.BeanValidatorPluginsConfiguration; @@ -39,7 +41,7 @@ public class SwaggerConfig extends WebMvcConfigurationSupport { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .select() - .apis(RequestHandlerSelectors.basePackage(swaggerEntity.path)) + .apis(RequestHandlerSelectors.withClassAnnotation(Api.class)) .paths(PathSelectors.any()) .build(); }