2 Star 3 Fork 1

acgist / muses

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

Muses

基于SpringCloudAlibaba技术栈微服务模板项目

优化位置

boot-model

模块

模块 描述
docs 配置文档
boot 启动模块
boot-dev 开发模块
boot-parent 依赖模块
gateway 网关服务模块
web-parent Web服务模块
rest-parent Rest服务模块
service-parent 内部服务模块

Web|Rest|Service

三个模块没有具体区分,均可按需向外提供服务。

规范

开发日志

  • [+] 添加功能
  • [-] 删除功能
  • [*] 修改功能
  • [!] 危险操作
  • [#] 没有完成
  • [~] 日常任务

符号说明

  • +:必选
  • *:可选

安全

Web服务

Web服务使用传统Session记录状态,通过RedisSession实现共享,需要用户自己通过拦截器或者Spring Security实现认证授权。

Session失效

如果Web登录成功访问没有集成RedisSession的项目,那么就会导致Session失效。 解决方法设置sessioncookie.namecookie.domain或者cookie.path进行区分。

Rest服务

Rest服务使用OAuth2服务通过网关实现统一认证鉴权

测试

为了方便测试后台接口,可以绕过网关直接请求WWW(Web/Rest)服务,需要配置system.rest.ignore-user=true忽略用户拦截。 如果需要模拟用户登陆需要添加请求头部current-user设置登陆用户信息。

配置

配置统一放在Nacos配置中心通过bootstrap.yml加载:

spring:
  application:
    name: acgist
  main:
    allow-circular-references: true
    allow-bean-definition-overriding: true
  profiles:
    active: @profile@
  cloud:
    nacos:
      username: @nacosUser@
      password: @nacosPassword@
      discovery:
        namespace: ${spring.profiles.active}
        server-addr: @nacos@
      config:
        namespace: ${spring.profiles.active}
        server-addr: @nacos@
        file-extension: yml
        refreshable-dataids: main.yml, task.yml, dubbo.yml

配置备份./docs/nacos_config.zip

版本

# 设置标签
git tag 1.0.0
# 设置版本
mvn versions:set -DnewVersion=1.0.0
mvn -N versions:update-child-modules
mvn versions:commit
# 配置中心
system.version=1.0.0

批量修改部署脚本

sed -i "s/1.0.0/1.1.0/g" `grep 1.0.0 -rl ./*.sh`

关机

  • 服务下线
  • kill -2 pid
  • kill -15 pid

系统配置

# 系统名称
system.name=muses
# 系统版本
system.version=1.0.0
# 机器编号(负数自动生成):主要用于生成ID(相同服务建议设置不同编号)
system.sn=-1
# 系统端口:随机生成
system.port=8080
# 系统序列化类型
system.serializer.type=jdk|jackson
# 是否自动配置MVC:请求拦截器、参数解析器
system.mvc=true|false
# Rest忽略用户拦截
system.rest.ignore-user=true|false
# 慢请求统计时间:毫秒
system.gateway.slow.request.duration=1000
# 静态资源地址
system.static.host=//localhost:8888
# 网关Topic
system.topic.gateway=topic-gateway
# 是否允许下线自动关机
system.shutdown.enable=true
# 自动关机等待时间:秒
system.shutdown.gracefully=30
# 缓存时间:分钟
system.cache.ttl=30
# 缓存前缀
system.cache.prefix=cache::
# 登陆失败最大次数
system.login.fail.count=5
# 登陆失败锁定时长:秒
system.login.fail.duration=1800
# Excel
system.excel.header.font=宋体
system.excel.header.size=16
system.excel.cell.font=宋体
system.excel.cell.size=12
system.excel.font.width=256
# 错误路径
system.error.path=/error
# 错误页面
system.error.view=/error

错误处理

系统已经统一处理所有异常错误,Web模块建议不要使用网关进行地址截取,同时配置错误路径防止重定向时跳转地址错误。

存在重定向的服务均不建议使用网关地址截取

Maven配置

# 应用启动JVM参数
system.maven.jvm.arg=
# 应用启动JVM内存
system.maven.jvm.mem=
# 作者
system.maven.vendor=acgist
# 模块
system.maven.module=com.acgist.muses
# 项目的根目录
system.maven.basedir=${project.basedir}
# 编码
system.maven.encoding=UTF-8
# 是否跳过打包
system.maven.skip.assembly=true

端口

模块 端口
gateway 8888
rest-oauth2 9999
web [18000,19000)
rest [19000,20000)

固定端口

# 配置
server.port=8888
# 命令
java -jar appliation.jar --server.port=8888
java -Dserver.port=8888 -jar appliation.jar
java -jar appliation.jar --system.port=8888
java -Dsystem.port=8888 -jar appliation.jar

完全随机

server.port=0

范围随机

server.port=${system.port:8080}

开发

服务实例里面所有业务逻辑都是测试使用,可以根据自己实际情况进行修改删除。

命名规范

名称 包名 描述
配置 com.acgist.**.config
过滤器 com.acgist.**.filter
监听器 com.acgist.**.listener
拦截器 com.acgist.**.inteceptor
控制器 com.acgist.**.controller
远程服务 com.acgist.**.api.impl
本地服务 com.acgist.**.service.impl
数据模块 com.acgist.**.dao.* es/neo4j/mapper/repository
数据模型 com.acgist.**.model.* es/neo4j/entity/vo/dto/type/request/response/exception

model.type存放实体枚举

Service规范

  • 本地Service接口不要使用I开头:UserService
  • 远程Service接口需要使用I开头:IUserService
  • 实现接口使用Impl结尾:UserServiceImpl
  • 不要使用继承BootService提供远程服务

JDK17

现在Dubbo暂不支持JDK17,需要添加以下参数才能启动:

--add-opens java.base/java.io=ALL-UNNAMED
--add-opens java.base/java.math=ALL-UNNAMED
--add-opens java.base/java.util=ALL-UNNAMED
--add-opens java.base/java.lang=ALL-UNNAMED
--add-opens java.rmi/sun.rmi.transport=ALL-UNNAMED
--add-opens java.base/java.lang.reflect=ALL-UNNAMED
--add-opens java.base/java.util.concurrent=ALL-UNNAMED

其他链接

SpringBoot配置

https://docs.spring.io/spring-boot/docs/current/reference/html/application-properties.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 2021 acgist 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.

简介

基于SpringCloudAlibaba技术栈微服务模板项目 展开 收起
Java 等 2 种语言
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/acgist/muses.git
git@gitee.com:acgist/muses.git
acgist
muses
muses
master

搜索帮助