README.md · kxian/mica

## mica（云母）
[![Build Status](https://www.travis-ci.org/lets-mica/mica.svg?branch=master)](https://www.travis-ci.org/lets-mica/mica)
![JAVA 8](https://img.shields.io/badge/JDK-1.8+-brightgreen.svg)
[![Mica Maven release](https://img.shields.io/nexus/r/https/oss.sonatype.org/net.dreamlu/mica-bom.svg?style=flat-square)](https://mvnrepository.com/artifact/net.dreamlu/mica-bom)
[![Mica maven snapshots](https://img.shields.io/nexus/s/https/oss.sonatype.org/net.dreamlu/mica-bom.svg?style=flat-square)](https://oss.sonatype.org/content/repositories/snapshots/net/dreamlu/)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/eadcb54f2ec14f31b8abf3ab13ad2d4d)](https://app.codacy.com/app/ChunMengLu/mica?utm_source=github.com&utm_medium=referral&utm_content=lets-mica/mica&utm_campaign=Badge_Grade_Settings)
[![GitHub](https://img.shields.io/github/license/lets-mica/mica.svg?style=flat-square)](https://github.com/lets-mica/mica/blob/master/LICENSE)

`Mica`，Spring Cloud 微服务开发核心包，支持 `web` 和 `webflux`。

`注意`：`snapshots` 版本会及时响应，修复最新的 `bug` 或者必要的需求。

| 依赖         | 版本              |
| ------------ | ----------------- |
| Spring | 5.x |
| Spring Boot  | 2.1.x             |
| Spring Cloud | Greenwich 版 |

![犬夜叉-云母](docs/img/mica-001.jpeg)

[**更新记录**](CHANGELOG.md)

## 模块划分
### mica-auto
1. 编译期生成 `spring.factories`。
2. 编译期生成 `spring-devtools.properties`。
3. 编译期生成 `FeignClient` 信息到 `spring.factories` 中，供 `mica-cloud` 中完成 `Feign` 自动化配置。

`文档地址`：[https://gitee.com/596392912/mica-auto](https://gitee.com/596392912/mica-auto)

### mica-core
- 常用工具包，基于 `Spring-core` 扩展增强，无其他依赖。
- 增强 cglib Bean copy，高性能（接近直接 get set），支持链式 bean，支持自动类型转换 。
- `$` 工具类快捷方法，不用再记忆到底有哪些工具类。
- 统一消息返回体，封装得更加好用。
- Jaskson Read Write HttpMessageConverter，分读写的消息转换器。
- Spring 枚举转换器，规则同 Jackson。

`文档地址`：[mica-core](https://www.dreamlu.net/docs/utils-common.html)

### mica-http
- `mica-http` 是 `okhttp` 的封装，Fluent 语法的 http 工具包，语法参考 HttpClient Fluent API。

`文档地址`：[mica-http](mica-http/README.md)

### mica-laytpl 
- laytpl 模板（将其引入到 java 中）

`文档地址`：[mica-laytpl](mica-laytpl/README.md)

### mica-launcher
- 项目启动器
- 启动信息打印
- 系统环境处理
- spi 扩展

`文档地址`：[mica-launcher](https://www.dreamlu.net/docs/launcher-profile.html)

### mica-boot
- 支持 `Spring boot web` 和 `Spring boot webflux`。
- 异步配置。
- 异常处理，未知异常发送 Event 事件，方便监听收集。
- swagger 自动化配置，加入 jar 包即可。
- jackson 配置。
- 文件上传配置。
- 文件下载，支持断点续传，浏览器兼容好。
- 请求日志打印，方便开发。
- url 版本号和 header 版本处理。

`文档地址`：[mica-boot](https://www.dreamlu.net/docs/boot-version.html)

### mica-boot-test
- 方便 mica-boot 测试，注入 mica-launcher 中注入的参数。

`文档地址`：[mica-boot-test](https://www.dreamlu.net/docs/boot-test.html)

### mica-log4j2
- mica log4j 配置。
- 基于 disruptor 异步日志，高性能。
- 非开发环境将 System.out 和 err 写入 log。

`文档地址`：[mica-log4j2](https://www.dreamlu.net/docs/log4j2.html)

### mica-captcha
- 验证码，支持 `webflux` 和 `serlvet`。

`文档地址`：[mica-captcha](https://www.dreamlu.net/docs/captcha.html)

### mica-cloud
- Feign 自动降级、header 透传、版本处理，结合 `mica-auto` 自动化配置。
- RestTemplate 自动配置，基于 okhttp 增强，添加请求日志和 Header 传递。
- hystrix 熔断器增强，支持 header 透传、当前用户获取和透传。
- Apollo Properties 配置刷新。

### mica-plus-error-catch
- 未知异常收集到 spring-cloud-stream 中，方便统一处理。

### mica-plus-redis
- redis cache name # 自动配置超时时间。
- 通用 MicaRedisCache Spring Bean。
- 分布式限流。

`文档地址`：[mica-plus-redis](mica-plus-redis/README.md)

### mica-plus-mongo
- mongo 复杂 tree 和 jsonNode 转换处理。

### mica-plus-swagger
- swagger 和 swagger-bootstrap-ui 依赖。

### mica-plus-ribbon
- 【优先级最高】ip 相同的服务（方便本地多服务联调）。
- 可设置选择的 ip 或者 ip 段，例如：`172.21.0.*`、`172.21.0.8*`。
- 可设定 `tag`，用于灰度，匹配：`nacos.discovery.metadata.tag`。

`文档地址`：[mica-plus-ribbon](mica-plus-ribbon/README.md)

## 已知问题
lombok 生成的 method 问题：https://github.com/rzwitserloot/lombok/issues/1861

对于 xX 类属性名，第一个小写，第二个大写的 bean 属性名，Map -> Bean 或 Bean -> Map 存在问题。

不打算做兼容，待 lombok 新版修复。

## 开源协议
![LGPL v3](docs/img/lgplv3-147x51.png)

## 协议解释
LGPL（[GNU Lesser General Public License](http://www.gnu.org/licenses/lgpl.html)）

LGPL是GPL的一个为主要为类库使用设计的开源协议。和GPL要求任何使用/修改/衍生之GPL类库的的软件必须采用GPL协议不同。LGPL允许商业软件通过类库引用(link)方式使用LGPL类库而不需要开源商业软件的代码。这使得采用LGPL协议的开源代码可以被商业软件作为类库引用并发布和销售。

但是如果修改LGPL协议的代码或者衍生，则所有修改的代码，涉及修改部分的额外代码和衍生的代码都必须采用LGPL协议。因此LGPL协议的开源代码很适合作为第三方类库被商业软件引用，但不适合希望以LGPL协议代码为基础，通过修改和衍生的方式做二次开发的商业软件采用。

## 用户权益
允许以引入不改源码的形式免费用于学习、毕设、公司项目、私活等。

特殊情况修改代码，但仍然想闭源需经过作者同意。

对未经过授权和不遵循 lgpl 协议二次开源或者商业化我们将追究到底。

参考请注明：参考自 mica：https://github.com/lets-mica/mica ，另请遵循 lgpl 协议。

`注意`：若禁止条款被发现有权追讨 **19999** 的授权费。

## 授权用户（最佳实践）
* `pigx` 宇宙最强微服务（架构师必备）：https://pig4cloud.com
* `bladex` 完整的线上解决方案（企业生产必备）：https://bladex.vip

## 相关链接
* `示例项目`：[https://github.com/lets-mica/mica-example](https://github.com/lets-mica/mica-example)
* mica 源码 Github：[https://github.com/lets-mica](https://github.com/lets-mica)
* mica 源码 Gitee（码云）：[https://gitee.com/596392912/mica](https://gitee.com/596392912/mica)
* mica 性能压测：[https://github.com/lets-mica/mica-jmh](https://github.com/lets-mica/mica-jmh)
* 文档地址（官网）：[https://www.dreamlu.net/docs/](https://www.dreamlu.net/docs/)
* 文档地址（语雀-可关注订阅）：[https://www.yuque.com/dreamlu/mica](https://www.yuque.com/dreamlu/mica)

## 开源推荐
- `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)
- `JustAuth` 史上最全的整合第三方登录的开源库: [https://github.com/zhangyd-c/JustAuth](https://github.com/zhangyd-c/JustAuth)
- `spring-boot-demo` 深度学习并实战 spring boot 的项目: [https://github.com/xkcoding/spring-boot-demo](https://github.com/xkcoding/spring-boot-demo)

## 鸣谢
感谢 JetBrains 提供的免费开源 License：

[![JetBrains](docs/img/jetbrains.png)](https://www.jetbrains.com/?from=mica)

感谢 `如梦技术VIP群` 小伙伴们的大力支持。

## 微信公众号

![如梦技术](docs/img/dreamlu-weixin.jpg)

精彩内容每日推荐！！！

kxian/mica

简介

发行版

贡献者

近期动态

kxian/mica .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

近期动态

搜索帮助

kxian/mica