微服务 on Macula

Macula Boot Starter Dubbo

Mon, 01 Jan 0001 00:00:00 +0000

概览

引入基于Dubbo的微服务框架。

组件坐标

<dependency>
 <groupId>dev.macula.boot</groupId>
 <artifactId>macula-boot-starter-cloud-alibaba</artifactId>
 <version>${macula.version}</version>
</dependency>

使用配置

基于springboot使用dubbo

请参考官方文档

核心功能

dubbo与spring cloud互通

TODO

依赖引入

<dependencies>
 <dependency>
 <groupId>org.apache.dubbo</groupId>
 <artifactId>dubbo-spring-boot-starter</artifactId>
 </dependency>
</dependencies>

版权说明

dubbo：https://github.com/apache/dubbo/blob/3.2/LICENSE

Macula Boot Starter Feign

Mon, 01 Jan 0001 00:00:00 +0000

概览

引入spring-cloud-openfeign并添加了HMAC拦截器、请求头传递等功能。

组件坐标

<dependency>
 <groupId>dev.macula.boot</groupId>
 <artifactId>macula-boot-starter-feign</artifactId>
 <version>${macula.version}</version>
</dependency>

使用配置

由于feign默认是使用httpclient，建议按照以下配置启用okhttp

feign:
 httpclient:
 enabled: false
 max-connections: 200 						# 线程池最大连接数，默认200
 time-to-live: 900 							# 线程存活时间，单位秒，默认900
 connection-timeout: 2000 			# 新建连接超时时间，单位ms, 默认2000
 follow-redirects: true 					# 是否允许重定向，默认true
 disable-ssl-validation: false 	# 是否禁止SSL检查， 默认false
 okhttp:
 read-timeout: 60s 						# 请求超时时间，Duration配置方式
 okhttp:
 enabled: true

核心功能

请求头传递

默认已经启用该拦截器，主要是为了把Token传递到下级微服务，以便通过安全校验。

/**
 * {@code HeaderRelayInterceptor} 将请求头传递到下面的微服务
 *
 * @author rain
 * @since 2022/7/23 12:57
 */
public class HeaderRelayInterceptor implements RequestInterceptor {

 @Override
 public void apply(RequestTemplate template) {
 ServletRequestAttributes attributes = (ServletRequestAttributes)RequestContextHolder.getRequestAttributes();
 if (null != attributes) {
 HttpServletRequest request = attributes.getRequest();

 // 微服务之间传递的唯一标识,区分大小写所以通过httpServletRequest获取
 String sid = request.getHeader(GlobalConstants.FEIGN_REQ_ID);
 if (!StringUtils.hasText(sid)) {
 sid = String.valueOf(UUID.randomUUID());
 }
 template.header(GlobalConstants.FEIGN_REQ_ID, sid);

 // 传递Gateway生成的Authorization头
 String token = request.getHeader(SecurityConstants.AUTHORIZATION_KEY);
 if (StringUtils.hasText(token)) {
 template.header(SecurityConstants.AUTHORIZATION_KEY, token);
 }
 }
 }
}

自动生成请求签名

/**
 * {@code KongApiInterceptor} KONG认证的API访问拦截签名
 *
 * @author rain
 * @since 2022/7/27 08:59
 */
@AllArgsConstructor
public class KongApiInterceptor implements RequestInterceptor {

 @NonNull
 private String username;
 @NonNull
 private String secret;
 private String appKey;

 public KongApiInterceptor(@NonNull String username, @NonNull String secret) {
 this.username = username;
 this.secret = secret;
 }

 @Override
 public void apply(RequestTemplate requestTemplate) {
 String date = DateUtil.formatHttpDate(new Date());
 requestTemplate.header("Date", date);
 // 签名，计算方法为 hmac_sha_256(key, 日期 + 方法 + 路径)
 HMac hmacSha256 = new HMac(HmacAlgorithm.HmacSHA256, secret.getBytes());
 String authorization = null;
 String method = requestTemplate.method();
 if (Request.HttpMethod.POST.name().equals(method) || Request.HttpMethod.PUT.toString().equals(method)) {
 // 请求体摘要
 MessageDigest messageDigest = null;
 try {
 messageDigest = MessageDigest.getInstance("SHA-256");
 } catch (NoSuchAlgorithmException e) {
 e.printStackTrace();
 }
 byte[] hash = messageDigest.digest(requestTemplate.body() == null ? new byte[] {} : requestTemplate.body());
 String digest = "SHA-256=" + Base64.encode(hash);
 requestTemplate.header("Digest", digest);
 // 签名，计算方法为 hmac_sha_256(key, 日期 + 方法 + 路径 + 摘要)
 String signature = hmacSha256.digestBase64(
 "date: " + date + "\n" + method + " " + requestTemplate.url() + " HTTP/1.1\ndigest: " + digest, false);
 authorization =
 "hmac username=\"" + username + "\", algorithm=\"hmac-sha256\", headers=\"date request-line digest\", signature=\"" + signature + "\"";
 } else if (Request.HttpMethod.GET.name().equals(method) || Request.HttpMethod.DELETE.toString()
 .equals(method)) {
 // 签名，计算方法为 hmac_sha_256(key, 日期 + 方法 + 路径)
 String signature =
 hmacSha256.digestBase64("date: " + date + "\n" + method + " " + requestTemplate.url() + " HTTP/1.1",
 false);
 authorization =
 "hmac username=\"" + username + "\", algorithm=\"hmac-sha256\", headers=\"date request-line\", signature=\"" + signature + "\"";
 }
 if (authorization != null) {
 requestTemplate.removeHeader(SecurityConstants.AUTHORIZATION_KEY);
 requestTemplate.header(SecurityConstants.AUTHORIZATION_KEY, authorization);
 }
 if (appKey != null) {
 requestTemplate.header("appkey", appKey);
 }
 }
}

该拦截器仅在需要的时候定义，当通过@FeignClient定义远程调用代理的时候，可以自动生成相应的访问参数或者签名，例如：

Macula Boot Starter Cloud Gateway

Mon, 01 Jan 0001 00:00:00 +0000

概览

网关服务模块，给每个平台应用依赖用的。主要提供token认证、鉴权、接口加解密等功能。

组件坐标


<dependency>
 <groupId>dev.macula.boot</groupId>
 <artifactId>macula-boot-starter-cloud-alibaba</artifactId>
 <version>${macula.version}</version>
</dependency>

<dependency>
<groupId>dev.macula.boot</groupId>
<artifactId>macula-boot-starter-cloud-alibaba-scg</artifactId>
<version>${macula.version}</version>
</dependency>

使用配置

spring:
 gateway:
 routes:
 - id: macula-cloud-system
 uri: lb://macula-cloud-system
 predicates:
 - Path=/system/**
 filters:
 - StripPrefix=1
 security:
 oauth2:
 resourceserver:
 opaquetoken:
 client-id: e4da4a32-592b-46f0-ae1d-784310e88423
 client-secret: secret
 introspection-uri: http://127.0.0.1:9010/oauth2/introspect 
 redis:																# 网关自己的redis配置
 database: 0										
 host: 127.0.0.1
 port: 6379
 system:															# macula-cloud的system模块的redis配置
 database: 0
 host: 127.0.0.1
 port: 6379
macula:
 gateway:
 sign-switch: true # 接口签名全局开关，默认true
 force-sign: false # 是否强制校验指定URL的接口签名，默认false
 crypto-switch: true 			# 接口加解密全局开关，默认true
 force-crypto: false 			# 是否强制校验指定URL的接口要不要加解密，默认false
 protect-urls: 						 # 需要保护的URL，前端可通过/gateway/protect/urls获取
 crypto: # 加密
 - /system/xxx/**
 - /mall/api/v1/xxx/**
 sign: # 签名
 - /system/xxx/*
 - /mall/api/v1/**
 security:
 ignore-urls: /usr/xxx,/bbb/xxx 		# 忽略认证的路径，Ant Path格式
 only-auth-urls: /usr/xx, /bbb/xxx 	# 仅需认证无需鉴权的路径

核心功能

Token认证

将oauth2的token转换为JWT传递给微服务，微服务通过JWT获取用户信息和角色信息。

Macula Boot Starter Cloud Alibaba

Mon, 01 Jan 0001 00:00:00 +0000

概览

基于Spring Cloud Alibaba的微服务开源套件Nacos、Sentinel等搭建微服务平台。

组件坐标

<!-- 微服务模块依赖 -->
<dependency>
 <groupId>dev.macula.boot</groupId>
 <artifactId>macula-boot-starter-cloud-alibaba</artifactId>
 <version>${macula.version}</version>
</dependency>

<!-- 网关模块依赖 -->
<dependency>
 <groupId>dev.macula.boot</groupId>
 <artifactId>macula-boot-starter-cloud-alibaba-scg</artifactId>
 <version>${macula.version}</version>
</dependency>

使用配置

在bootstrap.yml中如下配置，主要是配置中心的相关配置

server:
 port: 8081

spring:
 profiles:
 	# maven打包的时候指定profile，包括local,dev,test,staging,pet,prd，默认启用local
 active: @profile.active@ 
 application:
 name: macula-cloud-system
 cloud:
 nacos:
 username: ${nacos.username}
 password: ${nacos.password}
 config:
 server-addr: ${nacos.config.server-addr}
 namespace: ${nacos.config.namespace}
 # group:
 refresh-enabled: true
 file-extension: yml

# 和环境有关的配置信息，不同环境覆盖此处的配置
nacos:
 username: nacos
 password: nacos
 config:
 server-addr: 127.0.0.1:8848
 namespace: MACULA5

---
spring:
 config:
 activate:
 on-profile: dev
nacos:
 username: maculav5
 #password: 请通过启动命令赋予密码
 config:
 server-addr: 10.94.108.55:8848
 namespace: MACULA5

在nacos中以spring.application.name命名dataId，如果有profile则加上-xxx命名，后缀是yml，配置注册中心

Macula Boot Starter Cloud Tencent

Mon, 01 Jan 0001 00:00:00 +0000

概览

基于Spring Cloud Tencent的微服务开源套件Polarismesh搭建微服务平台。

组件坐标

<!-- 微服务模块依赖 -->
<dependency>
 <groupId>dev.macula.boot</groupId>
 <artifactId>macula-boot-starter-cloud-tencent</artifactId>
 <version>${macula.version}</version>
</dependency>

<!-- 网关模块依赖 -->
<dependency>
 <groupId>dev.macula.boot</groupId>
 <artifactId>macula-boot-starter-cloud-tencent-scg</artifactId>
 <version>${macula.version}</version>
</dependency>

使用配置

在bootstrap.yml中如下配置，主要是配置中心的相关配置

TODO

在polarismesh中以spring.application.name命名dataId，如果有profile则加上-xxx命名，后缀是yml，配置注册中心

TODO

核心功能

请参考官方文档

依赖引入

微服务模块

<dependencies>
 <!-- Spring Cloud -->
 <dependency>
 <groupId>dev.macula.boot</groupId>
 <artifactId>macula-boot-starter-feign</artifactId>
 </dependency>

 <dependency>
 <groupId>org.springframework.cloud</groupId>
 <artifactId>spring-cloud-starter-loadbalancer</artifactId>
 </dependency>

 <!-- Spring Cloud Tencent -->
 <dependency>
 <groupId>com.tencent.cloud</groupId>
 <artifactId>spring-cloud-starter-tencent-polaris-discovery</artifactId>
 </dependency>

 <dependency>
 <groupId>com.tencent.cloud</groupId>
 <artifactId>spring-cloud-starter-tencent-polaris-config</artifactId>
 </dependency>

 <dependency>
 <groupId>com.tencent.cloud</groupId>
 <artifactId>spring-cloud-starter-tencent-polaris-ratelimit</artifactId>
 </dependency>

 <dependency>
 <groupId>com.tencent.cloud</groupId>
 <artifactId>spring-cloud-starter-tencent-polaris-circuitbreaker</artifactId>
 </dependency>

 <dependency>
 <groupId>com.tencent.cloud</groupId>
 <artifactId>spring-cloud-starter-tencent-polaris-router</artifactId>
 </dependency>

 <dependency>
 <groupId>com.tencent.cloud</groupId>
 <artifactId>spring-cloud-starter-tencent-metadata-transfer</artifactId>
 </dependency>
</dependencies>

网关模块

Macula Boot Starter Cloud TSF

Mon, 01 Jan 0001 00:00:00 +0000

概览

基于腾讯云企业级微服务框架TSF搭建的微服务开发平台。

组件坐标

<!-- 微服务模块依赖 -->
<dependency>
 <groupId>dev.macula.boot</groupId>
 <artifactId>macula-boot-starter-cloud-tsf</artifactId>
 <version>${macula.version}</version>
</dependency>

<!-- 网关模块依赖 -->
<dependency>
 <groupId>dev.macula.boot</groupId>
 <artifactId>macula-boot-starter-cloud-tsf-scg</artifactId>
 <version>${macula.version}</version>
</dependency>

使用配置

在bootstrap.yml中如下配置，主要是公共配置

server:
 port: 7082

spring:
 profiles:
 	# maven打包的时候指定profile，包括local,dev,test,staging,pet,prd，默认启用local
 active: @profile.active@
 application:
 name: macula-example-tsf

在项目文件application.yml中如下配置，默认是本地配置。也可以使用application-xxx.yml区分不同环境的配置。

server:
 servlet:
 encoding:
 force: true

spring:
 security:
 oauth2:
 resourceserver:
 jwt:
 jwk-set-uri: http://127.0.0.1:8000/oauth2/jwks  # 网关地址

seata:
 enabled: false

feign:
 httpclient:
 enabled: false
 max-connections: 200 # 线程池最大连接数，默认200
 time-to-live: 900 # 线程存活时间，单位秒，默认900
 connection-timeout: 2000 # 新建连接超时时间，单位ms, 默认2000
 follow-redirects: true # 是否允许重定向，默认true
 disable-ssl-validation: false # 是否禁止SSL检查， 默认false
 okhttp:
 read-timeout: 60s # 请求超时时间，Duration配置方式
 okhttp:
 enabled: true
 sentinel:
 enabled: false

macula:
 security:
 ignore-urls:
 - /api/v1/tsf/echo

logging:
 level:
 root: info
 dev.macula.example: debug
 file:
 name: ${user.home}/logs/${spring.application.name}/${spring.application.name}.log

当系统部署到TSF时，如果使用TSF的配置管理，建议将bootstrap.yml内容作为应用的公共配置，环境相关配置分别关联到不同环境的部署组。