【新增】yudao-spring-boot-starter-signature接口签名模块 #526
Conversation
|
不错的 pr，我可能要周末在细看，非常感谢哈。 |
| @@ -23,6 +23,10 @@ public class CacheRequestBodyWrapper extends HttpServletRequestWrapper { | |||
| */ | |||
| private final byte[] body; | |||
|
|
|||
| public byte[] getBody() { | |||
There was a problem hiding this comment.
建议加一个 @VisableForTest 的注解，表示它是临时可见
There was a problem hiding this comment.
这个是Guava包中的@VisibleForTesting注解吗？搜索了一下，并未找到@VisableForTest注解相关资料
| @@ -25,6 +25,7 @@ public interface GlobalErrorCodeConstants { | |||
| ErrorCode METHOD_NOT_ALLOWED = new ErrorCode(405, "请求方法不正确"); | |||
| ErrorCode LOCKED = new ErrorCode(423, "请求失败，请稍后重试"); // 并发请求，不允许 | |||
| ErrorCode TOO_MANY_REQUESTS = new ErrorCode(429, "请求过于频繁，请稍后重试"); | |||
| ErrorCode SIGNATURE_REQUESTS = new ErrorCode(430, "签名失败"); | |||
There was a problem hiding this comment.
建议使用 400 Bad Request，提示可以使用，签名不正确
| <packaging>jar</packaging> | ||
|
|
||
| <name>${project.artifactId}</name> | ||
| <description>提供接口验签功能</description> |
| /** | ||
| * url客户端不需要传递，但是可以用来加签(如：/{id}带有动态参数的url，如果没有动态参数可设置为false，不进行加签) | ||
| */ | ||
| boolean urlEnable() default true; |
There was a problem hiding this comment.
一般带 url 的多么？
我瞅了几个平台，貌似带的不多。
所以在想，是不是默认不要这个属性哈？
There was a problem hiding this comment.
项目中基本没有带动态参数的，不过出于扩展性，或者以后考虑把framework做为组件发布至中央仓库供其他项目使用时，是有必要的
| Class<? extends SignatureApi> signatureApi() default DefaultSignatureApiImpl.class; | ||
|
|
||
| /** | ||
| * 同一个请求多长时间内有效 默认10分钟 |
There was a problem hiding this comment.
同一个请求多长时间内有效 默认 10 分钟
改成这个。中文写作习惯，中英文之间要有空格
| } | ||
| SignatureApi signatureApi = SpringUtil.getBean(signature.signatureApi()); | ||
| Assert.notNull(signatureApi, "找不到对应的 SignatureApi 实现"); | ||
| // 校验appId是否能获取到对应的appSecret |
| String serverSign = signatureApi.digestEncoder(signContent.toString()); | ||
| // 客户端签名 | ||
| String clientSign = request.getHeader(signature.sign()); | ||
| if (!StrUtil.equals(clientSign, serverSign)) { |
There was a problem hiding this comment.
StrUtil.notEquals
建议上，逻辑尽量避免 if (!xxx)
人对取反要多一层思考；
There was a problem hiding this comment.
StrUtil 中没有 notEquals 方法
| signContent.append(appSecret); | ||
|
|
||
| // 生成服务端签名 | ||
| String serverSign = signatureApi.digestEncoder(signContent.toString()); |
There was a problem hiding this comment.
这个签名，抽一个小方法在这个逻辑里。
第一期，就不要搞太复杂的哈。HMAC-SHA256 之类的就 ok 啦
| sortedMap.put("param", JsonUtils.toJsonString(paramMap)); | ||
| } | ||
|
|
||
| CacheRequestBodyWrapper requestWrapper = new CacheRequestBodyWrapper(request); |
There was a problem hiding this comment.
body 的话，建议是简单点；直接拿整个 requestBody；里面不需要再排序了；
可以在调研下其他做开放平台的，他们是怎么考虑的哈。
There was a problem hiding this comment.
好的，这个之前确实有考虑不需要排序。
| * @param args args | ||
| * @throws UnsupportedEncodingException | ||
| */ | ||
| public static void main(String[] args) throws UnsupportedEncodingException { |
|
第一轮 review 结束。整体写的蛮好的，实现思路没问题。 code review 给的建议，更多是希望怎么更简洁，满足绝大多数场景。 ps：有没可能基于 master-jdk17 改下，发起一次 pr 哈；因为项目是基于 master-jdk17，然后可以自动适配同步到 master 分支的噢 |
|
好的，感谢大佬采纳并给出建议，我明天按规范改一版 |
No description provided.