1 Star 0 Fork 7

Programer / smilehappiness-spring-cloud

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

@[TOC]

1 前言

Spring Cloud 官网,2021-07-06 发布了Hoxton.SR12 这个版本, 本来想使用 Hoxton.SR12这个Spring Cloud版本,查了一些资料,发现基于这个版本,好用的微服务架构体系并且开源的项目不是很多,可能是这个版本刚出来两三个月,就自己折腾了一个基础架构。在进行依赖管理的过程中,走了不少坑,各种jar冲突或者版本不兼容等等,这里总结记录下,防止以后再次踩坑。

该脚手架项目基于 Spring Boot+ Spring Cloud + MyBatis-Plus,为了提高项目的开发效率,降低项目的维护成本,避免重复造轮子,我基于我上一篇博客中的基础架构,搭建了一套脚手架,可以直接拿来使用。

2 脚手架主要提供哪些功能

该项目主要包括以下功能模块:

  • 统一管理项目依赖,核心依赖的版本控制
  • 缓存管理以及分布式锁的处理
  • 预警通知功能
  • 异常管理
  • 限流Api管理
  • Mock Server管理
  • 消息中间件MQ管理
  • 操作日志管理
  • 定时任务管理
  • Swagger-Ui管理
  • 工具类管理

3 如何使用该脚手架

3.1 项目统一依赖管理

  • 集成基础设施项目:

    在自己的maven项目中,在最顶层项目的pom文件中,继承该基础设施项目:

        <parent>
            <groupId>com.smilehappiness</groupId>
            <artifactId>smilehappiness-architecture</artifactId>
            <version>1.0.0</version>
        </parent>

3.2 集成基础模块功能到自己的项目中

下面的这些依赖的功能模块,可以根据实际情况,选择集成哪些功能模块,添加如下依赖,即可把基础设施项目的核心功能,集成到自己的项目中:

	<dependency>
	   <groupId>com.smilehappiness</groupId>
	    <artifactId>smilehappiness-cache</artifactId>
	    <exclusions>
	        <exclusion>
	            <artifactId>HdrHistogram</artifactId>
	            <groupId>org.hdrhistogram</groupId>
	        </exclusion>
	    </exclusions>
	</dependency>
	<dependency>
	    <groupId>com.smilehappiness</groupId>
	    <artifactId>smilehappiness-common</artifactId>
	</dependency>
	<dependency>
	    <groupId>com.smilehappiness</groupId>
	    <artifactId>smilehappiness-early-warning-notice</artifactId>
	</dependency>
	<dependency>
	    <groupId>com.smilehappiness</groupId>
	    <artifactId>smilehappiness-exception</artifactId>
	</dependency>
	<dependency>
	    <groupId>com.smilehappiness</groupId>
	    <artifactId>smilehappiness-limit-api</artifactId>
	</dependency>
	<dependency>
	    <groupId>com.smilehappiness</groupId>
	    <artifactId>smilehappiness-mq</artifactId>
	</dependency>
	<dependency>
	    <groupId>com.smilehappiness</groupId>
	    <artifactId>smilehappiness-operation-log</artifactId>
	</dependency>
	<dependency>
	    <groupId>com.smilehappiness</groupId>
	    <artifactId>smilehappiness-schedule</artifactId>
	</dependency>
	<dependency>
	    <groupId>com.smilehappiness</groupId>
	    <artifactId>smilehappiness-swagger-ui</artifactId>
	</dependency>
	<dependency>
	    <groupId>com.smilehappiness</groupId>
	    <artifactId>smilehappiness-utils</artifactId>
	</dependency>

4 基础核心功能模块的使用

4.1 集成缓存管理模块

分布式、微服务背景下,对于性能的要求也越来越高,所以缓存越来越受到了重视。现在使用比较流行的缓存是Redis,所以,笔者也基于Redis做缓存处理。

Redis常见的场景有: 普通缓存分布式锁分布式限流幂等性校验短信登录限定次数等等

4.1.1 添加cache模块依赖

     <dependency>
          <groupId>com.smilehappiness</groupId>
          <artifactId>smilehappiness-cache</artifactId>
     </dependency>

4.1.2 cache模块的功能使用

  • Redis工具的基本使用示例

    注入以下工具类:

    @Autowired
    private RedissonClient redissonClient;
    @Autowired
    private RedisUtil redisUtil;
    @Autowired
    private RedissonLockRedisUtil redissonLockRedisUtil;

然后使用以下测试用例:

public void testRedisUtil() {
    //赋值
    redisUtil.set("test1", "你好");
    //该工具类,默认过期单位为秒
    redisUtil.set("test2", "测试一下过期时间", 30);

    //取值
    System.out.println(redisUtil.get("test1"));
    System.out.println(redisUtil.get("test2"));

    //删除值
    redisUtil.del("test1");
}
  • Redis分布式锁工具的基本使用示例
 /**
   * <p>
   * 测试分布式锁的使用,基于Redisson客户端实现(该方法的实现推荐使用)
   * <p/>
   *
   * @param
   * @return void
   * @Date 2021/10/4 16:51
   */
  @Test
  public void testDistributeLock() {
      String bizLockKey = "smilehappiness:trialOrder:orderNumberxxxxxxx";

      //支持过期解锁功能,10秒钟以后自动解锁, 无需调用unlock方法手动解锁,当然,为了不占用资源,使用锁处理完业务,一般还是建议手动释放锁
      RLock lock = redissonLockRedisUtil.lock(bizLockKey, 60L);
      if (lock.tryLock()) {
          try {
              //处理业务方法。。。
          } catch (Exception e) {
              log.error("获取分布式锁失败,失败原因:{}", e);
              throw new SystemInternalException("获取分布式锁失败,失败原因:" + e.getMessage());
          } finally {
              lock.unlock();
          }
      } else {
          log.error("系统繁忙,请稍后再试!");
          throw new BusinessException("系统繁忙,请稍后再试!");
      }
  }

  /**
   * <p>
   * 测试分布式锁的使用,基于Redisson客户端实现(该方法的实现推荐使用)
   * <p/>
   *
   * @param
   * @return void
   * @Date 2021/10/4 16:51
   */
  @Test
  public void testDistributeLockTwo() {
      String bizLockKey = "smilehappiness:trialOrder:orderNumberxxxxxxx";

      //尝试加锁,最多等待30秒,上锁以后120秒自动解锁
      boolean lockFlag = redissonLockRedisUtil.tryLock(bizLockKey, 30L, 2 * 60L);
      if (lockFlag) {
          try {
              //处理业务方法。。。
          } catch (Exception e) {
              log.error("获取分布式锁失败,失败原因:{}", e);
              throw new SystemInternalException("获取分布式锁失败,失败原因:" + e.getMessage());
          } finally {
              redissonLockRedisUtil.unlock(bizLockKey);
          }
      } else {
          log.error("系统繁忙,请稍后再试!");
          throw new BusinessException("系统繁忙,请稍后再试!");
      }
  }

  /**
   * <p>
   * 测试分布式锁的使用,基于Redisson客户端实现方式
   * <p/>
   *
   * @param
   * @return void
   * @Date 2021/10/4 16:51
   */
  @Test
  public void testDistributeLockOriginal() {
      String bizLockKey = "smilehappiness:trialOrder:orderNumberxxxxxxx";
      RLock lock = redissonClient.getLock(bizLockKey);

      if (lock.tryLock()) {
          try {
              //处理业务方法。。。
          } catch (Exception e) {
              log.error("获取分布式锁失败,失败原因:{}", e);
              throw new SystemInternalException("获取分布式锁失败,失败原因:" + e.getMessage());
          } finally {
              lock.unlock();
          }
      } else {
          log.error("系统繁忙,请稍后再试!");
          throw new BusinessException("系统繁忙,请稍后再试!");
      }
  }

4.2 集成通知预警管理模块

目前,只设计了钉钉预警通知,后续可以集成邮件通知等等

4.2.1 添加通知预警模块依赖

     <dependency>
          <groupId>com.smilehappiness</groupId>
          <artifactId>smilehappiness-early-warning-notice</artifactId>
     </dependency>

4.2.2 添加yml配置

在yml文件或者properties配置文件中添加如下内容:

# 钉钉预警通知
earlyWarning:
  notice:
    # 一般预警通知
    generalDingNoticeUrl: xxx
    # 高频异常通知预警
    errorDingNoticeUrl: xxx

记录好机器人的Webhook 地址,可以在自己项目中调用此地址向群聊发送相关消息通知,做到项目异常的预警通知或者一些其它业务通知,至此已经设置完成,剩下的只需要自己在项目中需要预警的地方调用接口通知即可。

如果你设定的机器人类型是关键字,内容需要包含关键字,才可以发送通知成功

注:这里分为了两个地址,可以根据实际情况,来决定用一个还是用两个,使用的时候非常简单,在钉钉上创建一个机器人,把webhook地址复制过来即可,限于篇幅,就不再详细说明,玩不转的小伙伴,可以参考资料:https://blog.csdn.net/nbskycity/article/details/106068455

4.2.3 钉钉预警使用示例

  • 首先注入工具类

        @Autowired
        private DingTalkWarningNoticeServer dingTalkWarningNoticeServer;
  • 参考代码示例

    /**
     * 钉钉预警通知测试,注意,如果你设定的机器人类型是关键字,内容需要包含关键字,才可以发送通知成功
     */
    @Test
    public void testDingTalkNotice() {
        dingTalkWarningNoticeServer.sendWarningMessage("smile:这是一个警告的通知");
        //第一个参数title,可以理解为关键信息标识,后续跟踪日志可以使用该关键信息标识快速找到
        dingTalkWarningNoticeServer.sendWarningMessage("hello,", "smile:这是一个警告的通知");
    
        try {
            log.info("结果:{}", 1 / 0);
        } catch (Exception e) {
            dingTalkWarningNoticeServer.sendErrorMessage(StringUtils.join("smile:异常通知,原因:", e.getMessage()));
            dingTalkWarningNoticeServer.sendErrorMessage("world", StringUtils.join("smile:异常通知,原因:", e.getMessage()));
        }
    }

4.3 集成异常管理模块

项目中,经常会遇到各种各样的异常,有时候异常信息可以给用户看,比如说:银行卡号填写错误、邮箱格式不合法等、而有的信息不能给用户看,比如说:系统走神了...

还有一种场景,针对异常信息,有时候需要进行文字翻译,比如:系统返回的失败信息是 AAA,可能需要在适配层翻译为BBB返回给用户,可以做对照表等等进行处理

4.3.1 添加异常模块依赖

    <dependency>
        <groupId>com.smilehappiness</groupId>
        <artifactId>smilehappiness-exception</artifactId>
    </dependency>

4.3.2 使用异常

4.3.2.1 两种异常说明

目前定义了两种异常: 一种是业务异常,另外一种是系统级异常

  • 使用业务异常(BusinessException)时,异常信息会直接返回给用户端,业务异常支持添加了普通code,业务code,以及异常信息。在设计的时候,业务异常类这里额外添加一个业务bizCode参数为了后续扩展性更强(可以基于业务bizCode做不同的信息对照展示,对于前端而言,基于普通的code,200或者非200即可判断是否请求接口成功)

  • 使用系统级异常(SystemInternalException)时,针对这种系统异常,会统一降级处理,比如可以友好的返回:系统升级中,请您稍后再试...,而不是返回系统走神了或者一大串英文异常给客户

4.3.2.2 异常使用示例

具体使用可参考如下示例:

    @GetMapping("/getApiLoggerInfoByRequestUrlAndMethodName")
    public CommonResult<List<ApiLogger>> getApiLoggerInfoByRequestUrlAndMethodName(@RequestParam("requestUrl") String requestUrl, @RequestParam("methodName") String methodName) {
        LocalDateTime bizTimeStart = LocalDateTime.now();
        CommonResult<List<ApiLogger>> commonResult = new CommonResult<>();
        try {
            List<ApiLogger> apiLoggerList = apiLoggerService.getApiLoggerInfoByRequestUrlAndMethodName(requestUrl, methodName);
            if (CollectionUtils.isEmpty(apiLoggerList)) {
                throw new BusinessException(FrameworkBusinessExceptionEnum.API_LOGGER_INFO_NULL);
            }

            log.info("通过请求url和方法名称,获取日志信息接口返回结果:{}", JSON.toJSONString(commonResult));
            log.info("通过请求url和方法名称,获取日志信息方法执行耗时(毫秒):{}", DateUtil.getTakeTime(bizTimeStart, LocalDateTime.now(), TimeUnit.MILLISECONDS));

            return commonResult;
        } catch (BusinessException e) {
            log.error("【业务异常】通过请求url和方法名称,获取日志信息异常,异常原因:{}", e.getMessage());
            log.info("通过请求url和方法名称,获取日志信息方法执行耗时(毫秒):{}", DateUtil.getTakeTime(bizTimeStart, LocalDateTime.now(), TimeUnit.MILLISECONDS));

            throw new BusinessException(e.getCode(), e.getBizCode(), "通过请求url和方法名称,获取日志信息异常,异常原因:" + e.getMessage());
        } catch (Exception e) {
            log.error("【系统异常】通过请求url和方法名称,获取日志信息异常,异常原因:{}", e.getMessage());
            log.info("通过请求url和方法名称,获取日志信息方法执行耗时(毫秒):{}", DateUtil.getTakeTime(bizTimeStart, LocalDateTime.now(), TimeUnit.MILLISECONDS));

            throw new SystemInternalException("通过请求url和方法名称,获取日志信息异常,异常原因:" + e.getMessage());
        }
    }

限于篇幅,这里就不详细介绍了,详细的使用教程,可以参考我另外的博客,写的非常详细:


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.

简介

该项目基于 Spring Boot+ Spring Cloud + MyBatis-Plus,基于Hoxton.SR12这个Spring Cloud版本,开发了这一套Spring Cloud微服务项目脚手架。 展开 收起
Java
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/myprog/smilehappiness-spring-cloud.git
git@gitee.com:myprog/smilehappiness-spring-cloud.git
myprog
smilehappiness-spring-cloud
smilehappiness-spring-cloud
master

搜索帮助