From 8cf4f9b41a36a7004a684a35d65ae1ba25803e75 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=A6=82=E6=A2=A6=E6=8A=80=E6=9C=AF?= <596392912@qq.com> Date: Sat, 22 Jun 2019 14:57:55 +0800 Subject: [PATCH] =?UTF-8?q?:sparkles:=20codacy=20markdown=20=E6=A0=BC?= =?UTF-8?q?=E5=BC=8F=E4=BC=98=E5=8C=96.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CHANGELOG.md | 16 ++++++------ README.md | 18 ++++++------- mica-bom/README.md | 2 +- mica-boot/README.md | 6 ++--- .../src/main/resources/log/log4j2_debug.xml | 26 +++++++++++-------- .../src/main/resources/log/log4j2_info.xml | 26 +++++++++---------- .../src/main/resources/log/log4j2_warn.xml | 22 ++++++++-------- mica-plus-ribbon/README.md | 4 +-- mica-social/README.md | 6 ++--- 9 files changed, 65 insertions(+), 61 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 683fe249..132cbe38 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -19,7 +19,7 @@ - :zap: `BaseController` 改为 `IController` 方便业务中进行二次扩展。 - :sparkles: 添加 `lbWebClient` 和 `header` 透传处理功能，`Spring cloud gateway` 中用起来特`爽`。 - :sparkles: `LauncherService` 支持 ordered 排序. -- :zap: 优化redis组件， +- :zap: 优化 redis 组件， - :zap: 启动监听，如果有 swagger，打印 swagger ui 地址。 - :zap: 调整验证码旋转度数，避免文字遮挡。 - :zap: 优化异常处理. @@ -33,16 +33,16 @@ ### v1.1.1 - 2019-05-11 - :zap: 减少部分阿里巴巴规范问题。 -- :zap: 优化日志，dev 环境日志，不按内存切分，不使用gz压缩，避免每次本地重启生成日志文件。 -- :zap: 优化 StackTraceAsString 中 FastStringWriter 初始容量为200。 +- :zap: 优化日志，dev 环境日志，不按内存切分，不使用 gz 压缩，避免每次本地重启生成日志文件。 +- :zap: 优化 StackTraceAsString 中 FastStringWriter 初始容量为 200。 - :zap: 优化 ServiceException R 泛型。 - :sparkles: 添加 R.throw 系列方法，用于处理异常直接返回的情况。 - :zap: Try 添加 Runnable、Callable、Comparator 的 Lambda 受检异常处理。 -- :bug: 修复日期添加和减少的bug IW2IM。 +- :bug: 修复日期添加和减少的 bug IW2IM。 ### v1.1.0 - 2019-04-26 - :zap: 将 mica 版本写入 banner.txt。 -- :mute: nacos 日志影响了gateway 和 webflux 的日志，调高级别。 +- :mute: nacos 日志影响了 gateway 和 webflux 的日志，调高级别。 - :zap: 优化 Servlet 和 Webflux 请求日志打印效果。 - :sparkles: 添加部分工具类。 - :sparkles: 优化验证码生成。 @@ -52,7 +52,7 @@ - :sparkles: 开源 `mica-plus-error-catch` 模块。 - :sparkles: 开源 `mica-plus-redis` 模块。 - :sparkles: 开源 `mica-plus-mongo` 模块。 -- :sparkles: 添加Validated Get、Create、Update、DeleteGroup。 +- :sparkles: 添加 Validated Get、Create、Update、DeleteGroup。 ### v1.0.1 - 2019-04-03 - :ok_hand: 处理几处 P3C 代码检查问题。@冷冷 @@ -72,7 +72,7 @@ - :zap: 优化文件下载。 ### v0.0.1-RC4 - 2019-03-13 -- :heavy_plus_sign: webflux url 版本号和 header版本处理。 +- :heavy_plus_sign: webflux url 版本号和 header 版本处理。 - :heavy_plus_sign: webflux 异常统一处理，未知异常发送 Event 事件，方便监听收集。 - :heavy_plus_sign: webflux 枚举转换，规则同 jackson。 - :heavy_plus_sign: webflux RequestContextHolder，方便获取 webflux request。 @@ -81,7 +81,7 @@ - :zap: 优化 base64 验证码。可完美结合 mica-pro redis cache name # 号分割超时。 - :loud_sound: 优化`请求日志`，避免并发下顺序错乱。 - :pushpin: 升级 `mica-auto`。 -- :zap: 优化UUID，采用 java9的方式，提高性能。 +- :zap: 优化 UUID，采用 java9 的方式，提高性能。 - :heavy_plus_sign: bom 添加 `mica-pro` 依赖。 - :loud_sound: 异常事件添加触发时间。 - :pencil2: fix spelling issue about black -> blank。 `感谢：` github @xkcoding diff --git a/README.md b/README.md index a15eedc6..875d47ec 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ ![犬夜叉-云母](docs/img/mica-001.jpeg) -想要了解更多可加入【如梦技术】QQ群：`479710041`。 +想要了解更多可加入【如梦技术】QQ 群：`479710041`。 ## 模块划分 ### mica-auto @@ -29,7 +29,7 @@ ### mica-core - 常用工具包，基于 `Spring-core` 扩展增强，无其他依赖。 -- 增强 cglib Bean copy，高性能（接近直接get set），支持链式 bean，支持类型转换 。 +- 增强 cglib Bean copy，高性能（接近直接 get set），支持链式 bean，支持类型转换 。 - `$` 工具类快捷方法，不用再记忆到底有哪些工具类。 - 统一消息返回体，封装得更加好用。 - Jaskson Read Write HttpMessageConverter，分读写的消息转换器。 @@ -48,8 +48,8 @@ - 支持 `Spring boot web` 和 `Spring boot webflux`。 - 异步配置。 - 异常处理，未知异常发送 Event 事件，方便监听收集。 -- swagger自动化配置，加入jar包即可。 -- jackson配置。 +- swagger 自动化配置，加入 jar 包即可。 +- jackson 配置。 - 文件上传配置。 - 文件下载，支持断点续传，浏览器兼容好。 - 请求日志打印，方便开发。 @@ -59,7 +59,7 @@ - 方便 mica-boot 测试，注入 mica-launcher 中注入的参数。 ### mica-log4j2 -- mica log4j配置。 +- mica log4j 配置。 - 基于 disruptor 异步日志，高性能。 - 非开发环境将 System.out 和 err 写入 log。 @@ -71,7 +71,7 @@ ### mica-cloud - Feign 自动降级、header 透传、版本处理，结合 `mica-auto` 自动化配置。 -- RestTemplate自动配置，基于okhttp增强，添加请求日志和Header传递。 +- RestTemplate 自动配置，基于 okhttp 增强，添加请求日志和 Header 传递。 - hystrix 熔断器增强，支持 header 透传、当前用户获取和透传。 - Apollo Properties 配置刷新。 @@ -112,7 +112,7 @@ lombok 生成的 method 问题：https://github.com/rzwitserloot/lombok/issues/1 参考请注明：参考自 mica：https://github.com/lets-mica/mica -`注意`：若禁止条款被发现有权追讨19999的授权费。 +`注意`：若禁止条款被发现有权追讨 **19999** 的授权费。 ## 授权用户（最佳实践） * `pigx` 宇宙最强微服务（架构师必备）：https://pig4cloud.com @@ -126,10 +126,10 @@ lombok 生成的 method 问题：https://github.com/rzwitserloot/lombok/issues/1 * 文档地址（语雀-可关注订阅）：[https://www.yuque.com/dreamlu/mica](https://www.yuque.com/dreamlu/mica) ## 开源推荐 -- `Avue` 一款基于vue可配置化的神奇框架：[https://gitee.com/smallweigit/avue](https://gitee.com/smallweigit/avue) +- `Avue` 一款基于 vue 可配置化的神奇框架：[https://gitee.com/smallweigit/avue](https://gitee.com/smallweigit/avue) - `pig` 宇宙最强微服务（架构师必备）：[https://gitee.com/log4j/pig](https://gitee.com/log4j/pig) - `SpringBlade` 完整的线上解决方案（企业开发必备）：[https://gitee.com/smallc/SpringBlade](https://gitee.com/smallc/SpringBlade) -- `IJPay` 支付SDK让支付触手可及：[https://gitee.com/javen205/IJPay](https://gitee.com/javen205/IJPay) +- `IJPay` 支付 SDK 让支付触手可及：[https://gitee.com/javen205/IJPay](https://gitee.com/javen205/IJPay) ## 鸣谢 感谢 `如梦技术VIP群` 小伙伴们的支持。 diff --git a/mica-bom/README.md b/mica-bom/README.md index 9c7d2714..1cdabbf5 100644 --- a/mica-bom/README.md +++ b/mica-bom/README.md @@ -1,5 +1,5 @@ ## mica-bom -`mica-bom`，可以简化依赖和依赖版本统一处理，避免jar冲突。 +`mica-bom`，可以简化依赖和依赖版本统一处理，避免 jar 冲突。 ### Maven ```xml diff --git a/mica-boot/README.md b/mica-boot/README.md index 6bdcf0cb..103bdcd1 100644 --- a/mica-boot/README.md +++ b/mica-boot/README.md @@ -2,8 +2,8 @@ ## 功能 1. 异步配置 2. 异常处理 -3. swagger配置 -4. jackson配置 +3. swagger 配置 +4. jackson 配置 5. 文件上传配置 6. 请求日志 7. `url` 版本号处理 @@ -19,7 +19,7 @@ 3. ... ... ### 不是用网关，单体应用 -拦截器处理，基于 redis 的 cache 时间或者 RateLimiter处理。 +拦截器处理，基于 redis 的 cache 时间或者 RateLimiter 处理。 结构：serviceName:http-cache:/user/1?queryString If-Modified-Since 结构：serviceName:RateLimiter:/user/1 99 diff --git a/mica-log4j2/src/main/resources/log/log4j2_debug.xml b/mica-log4j2/src/main/resources/log/log4j2_debug.xml index f635fe17..cf60da89 100644 --- a/mica-log4j2/src/main/resources/log/log4j2_debug.xml +++ b/mica-log4j2/src/main/resources/log/log4j2_debug.xml @@ -78,25 +78,29 @@ + + + + - - + + - + - + - - - + + + - + - - + + - + diff --git a/mica-log4j2/src/main/resources/log/log4j2_info.xml b/mica-log4j2/src/main/resources/log/log4j2_info.xml index 8fdb0a07..dc23dda3 100644 --- a/mica-log4j2/src/main/resources/log/log4j2_info.xml +++ b/mica-log4j2/src/main/resources/log/log4j2_info.xml @@ -30,26 +30,26 @@ - - - + + + - - + + - + - - - + + + - + - - + + - + diff --git a/mica-log4j2/src/main/resources/log/log4j2_warn.xml b/mica-log4j2/src/main/resources/log/log4j2_warn.xml index e64d8976..2dc8ba12 100644 --- a/mica-log4j2/src/main/resources/log/log4j2_warn.xml +++ b/mica-log4j2/src/main/resources/log/log4j2_warn.xml @@ -30,24 +30,24 @@ - + - - + + - + - - - + + + - + - - + + - + diff --git a/mica-plus-ribbon/README.md b/mica-plus-ribbon/README.md index e59f542a..40342069 100644 --- a/mica-plus-ribbon/README.md +++ b/mica-plus-ribbon/README.md @@ -27,8 +27,8 @@ compile("net.dreamlu:mica-plus-ribbon:${version}") | 配置项 | 默认值 | 说明 | | ------------------------- | ------ | -------------------------------------------------------- | | enabled | true | 是否启用 | -| prior-ip-pattern | 空 | 优先的ip列表，支持通配符，例如：172.21.0.81、172.21.0.8*、172.21.0.* | -| tag | 无 | 服务的tag，用于灰度，匹配：nacos.discovery.metadata.tag | +| prior-ip-pattern | 空 | 优先的 ip 列表，支持通配符，例如：172.21.0.81、172.21.0.8*、172.21.0.* | +| tag | 无 | 服务的 tag，用于灰度，匹配：nacos.discovery.metadata.tag | ## 配置示例 diff --git a/mica-social/README.md b/mica-social/README.md index 4499ef43..980f7292 100644 --- a/mica-social/README.md +++ b/mica-social/README.md @@ -1,10 +1,10 @@ # 第三方登录组件 -`mica-social`，如你所见，它仅仅是一个**第三方授权登录**的**工具类库**，它可以让我们脱离繁琐的第三方登录SDK，让登录变得**So easy!** +`mica-social`，如你所见，它仅仅是一个**第三方授权登录**的**工具类库**，它可以让我们脱离繁琐的第三方登录 SDK，让登录变得**So easy!** `mica-social` 参考了 `JustAuth` 和我之前的 [`JFinal-oauth2.0-login`](https://gitee.com/596392912/JFinal-oauth2.0-login) -## API列表 +## API 列表 | :computer: 平台 | |:------:| | gitee | @@ -28,7 +28,7 @@ | toutiao | | csdn | -_请知悉：经咨询CSDN官方客服得知，CSDN的授权开放平台已经下线。如果以前申请过的应用，可以继续使用，但是不再支持申请新的应用。so, 本项目中的CSDN登录只能针对少部分用户使用了_ +`注`：CSDN 的授权开放平台已经下线。so, 本项目中的 CSDN 登录只能针对少部分用户使用。 ## 添加依赖 ### maven -- GitLab