README_EN.md 7.1 KB
Newer Older
1
## 🌐 mica(云母)
Z
zouqing 已提交
2 3 4 5 6 7 8 9 10 11

[![Java CI](https://github.com/lets-mica/mica/workflows/Java%20CI/badge.svg)](https://github.com/lets-mica/mica/actions)
![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://app.codacy.com/project/badge/Grade/1d1253221f524945882ff480351cfa6b)](https://www.codacy.com/gh/lets-mica/mica/dashboard?utm_source=github.com&utm_medium=referral&utm_content=lets-mica/mica&utm_campaign=Badge_Grade)
[![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 micro core services development package to support` web` and `webflux`.

12
English | [简体中文](README.md)
Z
zouqing 已提交
13

14
## 🔖 Imprint
Z
zouqing 已提交
15 16 17

| Latest version | mica version     | spring boot version | spring cloud version |
| -------------- | ---------------- | ------------------- | -------------------- |
18 19
| 2.5.3          | mica 2.5.x       | 2.5.x               | 2020                 |
| 2.4.9          | mica 2.4.x       | 2.4.x               | 2020                 |
Z
zouqing 已提交
20 21
| 2.1.1-GA       | mica 2.0.x~2.1.x | 2.2.x ~ 2.3.x       | Hoxton               |

22
## 🏷️ Version number description
Z
zouqing 已提交
23 24 25 26 27 28 29

The format of `release` version number is `x.x.x`, which is basically consistent with `Spring boot`.

The format of `snapshots` version number is `x.x.x-SNAPSHOT`.

`Note`: The `snapshots` version will be automatically released after `push`, and respond to and fix the latest `bug` and requirements in a timely manner. 

30
## 📝 Use documentation 
Z
zouqing 已提交
31 32 33 34 35 36 37

**Use document** See: [http://wiki.dreamlu.net (mica2.x use document)](http://wiki.dreamlu.net/guide/getting-started.html)

**Update log** Please refer to: [Mica update log](CHANGELOG.md) 



38
## 🌱 mica ecology
Z
zouqing 已提交
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55

-mica-auto (Spring boot starter tool): https://gitee.com/596392912/mica-auto 

-mica-weixin (spring boot starter of jfinal weixin): https://gitee.com/596392912/mica-weixin 

-mica-mqtt (mqtt component based on t-io implementation): https://gitee.com/596392912/mica-mqtt 

-Spring cloud microservice http2 solution (h2c): https://gitee.com/596392912/spring-cloud-java11 

-mica-security (mica permission system vue is under reconstruction): https://gitee.com/596392912/mica-security



![mica 2.x module diagram](docs/img/mica2.x-open.jpg)



56
## 🐛 Known issues
Z
zouqing 已提交
57 58 59 60 61 62 63 64 65

Method issue generated by lombok: https://github.com/rzwitserloot/lombok/issues/1861

For the attribute name of the xX class, the first is lowercase and the second is uppercase bean attribute name, Map -> Bean or Bean -> Map has a problem.

Do not intend to be compatible, the new version to be lombok repair. 



66
## 📌 Open Source Agreement
Z
zouqing 已提交
67 68 69 70 71 72 73

![LGPL v3](docs/img/lgplv3-147x51.png)

**Soft work number**: `2020SR0411603`



74
### 📄 Agreement explanation
Z
zouqing 已提交
75 76 77 78 79 80 81 82 83

LGPL ([GNU Lesser General Public License](http://www.gnu.org/licenses/lgpl.html))

LGPL is an open source agreement of GPL designed mainly for the use of class libraries. It is different from the GPL requirement that any software that uses/modifies/derives the GPL library must adopt the GPL agreement. LGPL allows commercial software to use LGPL class libraries through class library links without the need for open source commercial software codes. This allows the open source code that adopts the LGPL agreement to be referenced, published and sold by commercial software as a class library. 

However, if the code of the LGPL agreement is modified or derived, all the modified code, the additional code involving the modified part and the derived code must adopt the LGPL agreement. Therefore, the open source code of the LGPL agreement is very suitable as a third-party class library to be cited by commercial software, but it is not suitable for commercial software that hopes to use the LGPL agreement code as the basis for secondary development through modification and derivation. 



84
### ✅ User rights
Z
zouqing 已提交
85 86 87 88 89 90 91 92 93 94 95 96 97

It is allowed to be used for learning, completion, company projects, private work, etc. for free in the form of introducing the source code without changing it.

Modify the code in special circumstances, but still want to close the source requires the author's consent.

For not authorized and do not follow the LGPL open source or secondary commercialization, we will pursue in the end.

Please note for reference: reference from mica: https://github.com/lets-mica/mica, please also follow the LGPL agreement.

`Note`: If the prohibition clause is discovered, it has the right to recover the authorization fee of **19999**.



98
### 🗃️ Authorized users (best practice)
Z
zouqing 已提交
99 100 101 102 103 104 105

-`pigx`, the most powerful microservice in the universe (a must for architects): https://pig4cloud.com

-`bladex` complete online solution (necessary for enterprise production): https://bladex.vip 



106
## 🔍️ Related links
Z
zouqing 已提交
107 108 109 110 111 112 113 114 115 116 117 118 119

-mica source code Github: [https://github.com/lets-mica](https://github.com/lets-mica)

-mica source code Gitee (code cloud): [https://gitee.com/596392912/mica](https://gitee.com/596392912/mica)

-mica performance pressure test: [https://github.com/lets-mica/mica-jmh](https://github.com/lets-mica/mica-jmh)

-Document address (official website): [http://wiki.dreamlu.net](http://wiki.dreamlu.net/guide/getting-started.html)

-Document address (Yuque-Follow and subscribe): [https://www.yuque.com/dreamlu](https://www.yuque.com/dreamlu)



120
## 🍻 Open source recommendation
Z
zouqing 已提交
121 122 123 124 125 126 127 128 129 130 131 132 133

-`Avue` a magical framework based on vue configurability: [https://gitee.com/smallweigit/avue](https://gitee.com/smallweigit/avue)

-`pig` the strongest microservice in the universe (a must for architects): [https://gitee.com/log4j/pig](https://gitee.com/log4j/pig)

-`SpringBlade` complete online solution (required for enterprise development): [https://gitee.com/smallc/SpringBlade](https://gitee.com/smallc/SpringBlade)

-`IJPay` payment SDK makes payment at your fingertips: [https://gitee.com/javen205/IJPay](https://gitee.com/javen205/IJPay)

-`JustAuth` The most complete open source library that integrates third-party login in history: [https://github.com/zhangyd-c/JustAuth](https://github.com/zhangyd-c/JustAuth)

-`spring-boot-demo` Deep learning and actual spring boot project: [https://github.com/xkcoding/spring-boot-demo](https://github.com/xkcoding/spring-boot-demo ) 

134
## 💚 Thanks
Z
zouqing 已提交
135 136 137 138 139 140 141 142 143

Thanks to the free open source license provided by JetBrains:

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

Thanks to the support of `Rumeng Technology VIP` **Little friends**, for more **VIP** information, please visit: https://www.dreamlu.net/vip/index.html



144
## 📱 WeChat public account
Z
zouqing 已提交
145 146 147 148 149

![`Rumeng Technology](docs/img/dreamlu-weixin.jpg)

Wonderful content recommended daily! ! !

150
## 🏗️ Contributor
Z
zouqing 已提交
151 152 153 154

![contributors](https://whnb.wang/contributors/596392912/mica)

![Stargazers over time](https://whnb.wang/img/596392912/mica)