3 Star 4 Fork 4

xuxiaowei-cloud / spring-cloud-xuxiaowei

Create your Gitee Account
Explore and code with more than 12 million developers,Free private repositories !:)
Sign up
Clone or Download
contribute
Sync branch
Cancel
Notice: Creating folder will generate an empty file .keep, because not support in Git
Loading...
README
Apache-2.0

spring-cloud-xuxiaowei

徐晓伟微服务

支持 Spring Boot 2、3 最新版

License-Anti Link-996 QQ群 Codacy Badge Codecov Badge

文档

平台 链接 说明
Gitee Pages 链接 自动化部署
GitHub Pages 链接 自动化部署
FramaGit Pages 链接 自动化部署

项目说明

  1. 本项目为重构项目,与原始项目存在较大差异
  2. 本项目从头开发,在 B站 有配套视频(充电专属)
    1. 搜索 重构微服务
    2. 查看 充电专属视频
  3. 表结构、数据(包含 Nacos 配置)在 sql 文件夹
  4. CodeCov 代码覆盖率
  5. 原始项目地址:
Gitee GitHub
Spring Boot 2 链接 链接
Spring Boot 3 链接 链接

项目开发的原则

分支

  1. 功能同时更新 spring-boot-2spring-boot-3 两个分支
  2. 先开发 spring-boot-2 分支,然后使用 git cherry-pick(摘樱桃) 将功能同步到 spring-boot-3 分支,并根据代码内容做调整

依赖

  1. Spring 全家桶(不使用 Shiro 等其他安全框架)
    1. Spring Security
    2. Spring Security OAuth2 Authorization Server(OAuth 2.1)
  2. 尽量少的使用其他依赖
    1. 使用 springdoc 生成 API 文档:支持 OpenAPI 3Swagger-uiOAuth 2.1
    2. JSON 处理使用 jacksonObjectMapper,不使用 fastjsonhutool
    3. 连接池使用 Spring Boot 默认的 hikari,不使用 druid
    4. HTTP 请求使用 Spring 的 RestTemplateWebClient,不使用 httpclienthutool
    5. Redis 操作使用 Spring 的 StringRedisTemplateRedisTemplate
    6. 其他工具类使用 org.apache.commons:commons-lang3com.google.guava:guava,不使用 hutool
  3. 已上依赖不能满足的情况,自己写,并且包含完善的测试类
  4. 依赖保存最新
    1. 使用 dependabot.yml 检测依赖升级创建升级依赖PR执行自动化测试人工审核, 通过后合并到目标分支

代码格式

  1. Java 使用 spring-javaformat

    1. Spring 提供:IntelliJ IDEA、Visual Studio Code、Eclipse 插件,可在开发过程中对代码进行格式化,插件请与项目依赖保持一致
    2. IDEA 插件下载地址(下载最大的文件): spring-javaformat-intellij-idea-plugin
    3. 可使用 mvn 命令格式化 Java 代码:需要当前操作系统可以正常执行 mvn 命令
      mvn spring-javaformat:apply
  2. Node 使用 prettier

功能

  1. 每开发一个功能,要包含详细的自动化测试
  2. 每发现一个bug,修复时要包含详细的自动化测试,测试内容包含能复现 bug 的测试
  3. 十二要素应用宣言
    1. I. 基准代码 一份基准代码(Codebase),多份部署(deploy)
    2. II. 依赖 显式声明依赖关系
    3. III. 配置 在环境中存储配置
    4. V. 构建,发布,运行 严格分离构建和运行
    5. X. 开发环境与线上环境等价 尽可能的保持开发,预发布,线上环境相同
  4. 评价一个项目是否优秀的其中一个因素:在不修改基础代码和基础数据的情况下,是否可以随时开源

自动化流水线

测试

  • 测试开始时,创建一个空的 MySQL 数据库,自动化脚本创建数据库与表结构,导入基础数据,然后再打包,运行单元测试、集成测试
  • 测试开始时,创建 Redis,用于后续自动化测试
类型 流水线配置文件 流水线运行记录
GitLab 流水线 .gitlab-ci.yml GitLab Pipelines
GitHub 流水线 maven-spring-boot-2.yml GitHub Actions
Jenkins 流水线 Jenkinsfile 无公开服务

项目功能

OAuth 2.1

  • 基于 OAuth 2.1 的 0.4.5 标签默认示例配置
    • 其中 bWVzc2FnaW5nLWNsaWVudDpzZWNyZXQ=客户ID:客户秘钥 messaging-client:secret 计算 base64 得到的
名称 自动化测试
用户名 user1
密码 password
客户ID messaging-client
客户秘钥 secret
客户认证方式 client_secret_basic
客户授权方式 authorization_code、refresh_token、client_credentials
客户回调地址 http://127.0.0.1:8080/login/oauth2/code/messaging-client-oidc , http://127.0.0.1:8080/authorized , https://home.baidu.com/home/index/contact_us
客户授权范围 openid、profile、message.read、message.write
客户手动授权同意 true
授权请求 URL http://127.0.0.1:9000/oauth2/authorize?client_id=messaging-client&redirect_uri=https://home.baidu.com/home/index/contact_us&response_type=code&scope=openid%20profile%20message.read%20message.write&state=beff3dfc-bad8-40db-b25f-e5459e3d6ad7
授权码获取 Token URL curl --request POST --url http://127.0.0.1:9000/oauth2/token --header 'Authorization: Basic bWVzc2FnaW5nLWNsaWVudDpzZWNyZXQ=' --header 'content-type: multipart/form-data' --form redirect_uri=https://home.baidu.com/home/index/contact_us --form grant_type=authorization_code --form code=你的授权码 AuthorizationCodeTests.java
刷新 Token URL curl --request POST --url http://127.0.0.1:9000/oauth2/token --header 'Authorization: Basic bWVzc2FnaW5nLWNsaWVudDpzZWNyZXQ=' --header 'content-type: multipart/form-data' --form grant_type=refresh_token --form refresh_token=你的刷新Token AuthorizationCodeTests.java
凭证式 URL curl --request POST --url http://127.0.0.1:9000/oauth2/token --header 'Authorization: Basic bWVzc2FnaW5nLWNsaWVudDpzZWNyZXQ=' --header 'content-type: multipart/form-data' --form scope="openid profile message.read message.write" --form grant_type=client_credentials ClientCredentialsTests.java

Springdoc (API)

Name 服务 地址 说明
gateway 网关 http://127.0.0.1:8000/webjars/swagger-ui/index.html 网关聚合所有服务的 API 文档
passport 登录授权服务 http://127.0.0.1:9000/swagger-ui/index.html
file 文件服务 http://127.0.0.1:12000/swagger-ui/index.html
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

About

Cancel

Releases

No release

Contributors

All

Activities

Load More
can not load any more
1
https://gitee.com/xuxiaowei-cloud/spring-cloud-xuxiaowei.git
git@gitee.com:xuxiaowei-cloud/spring-cloud-xuxiaowei.git
xuxiaowei-cloud
spring-cloud-xuxiaowei
spring-cloud-xuxiaowei
spring-boot-2

Search