基于注解的 java 加签验签框架 checksum

男娘i 2022-01-28 19:34 388阅读 0赞

# checksum #

基于 java 注解生成加签验签 checksum。

> 开源地址：[github checksum][]

## 创作缘由 ##

原来的代码中，checksum 的生成是用的工具类方法。

后来发现如下的问题：

1.  有些字段太大，不想参与验签，但是无法方便的调整。
2.  不同系统的 checksum 字段不同，只好把工具方法 copy 过去，改来改去。

感觉这样有很大的弊端，完全失去了灵活性。

## 特性 ##

*  基于注解的 checksum 加签验签
 *  Fluent 流式语法
 *  支持灵活的策略自定义

## 更新记录 ##

> 更新记录

# 快速开始 #

## 环境要求 ##

jdk7+

maven 3.x+

## 引入 ##

<dependency>
        <groupId>com.github.houbb</groupId>
        <artifactId>checksum</artifactId>
        <version>0.0.1</version>
    </dependency>

## 定义待加签的示例对象 ##

*  User.java

public class User { 
    
        @CheckField
        private String name;
    
        @CheckField
        private String password;
    
        private String address;
    
        @Checksum
        private String checksum;
    
        //Getter & Setter
        //toString()
    }

### 核心注解 ###

`@CheckField` 表示参与加签的字段信息

`@Checksum` 表示加签结果存放的字段

## 调用测试 ##

package com.github.houbb.checksum.core;
    
    import com.github.houbb.checksum.model.User;
    import org.junit.Assert;
    import org.junit.Test;
    
    /** * @author binbin.hou * @since 0.0.1 */
    public class ChecksumBsTest { 
    
        @Test
        public void checksumTest() { 
            User user = buildUser();
            final String checksum = ChecksumBs
                    .newInstance(user)
                    .checksum();
    
            Assert.assertEquals("8D62F2BC49A9AB51280C8F42A483ED54", checksum);
        }
    
        @Test
        public void fillTest() { 
            User user = buildUser();
            ChecksumBs.newInstance(user).fill();
    
            Assert.assertEquals("User{name='ryo', password='1234', address='china', checksum='8D62F2BC49A9AB51280C8F42A483ED54'}",
                    user.toString());
        }
    
        /** * 构建示例对象 * @return 构建示例对象 */
        private User buildUser() { 
            User user = new User();
            user.name("ryo")
                    .password("1234")
                    .address("china");
            return user;
        }
    
    }

# ChecksumBs 引导类 #

用来创建加签的相关配置及实现。

## 配置核心方法 ##

<table> 
 <thead> 
  <tr> 
   <th align="left">方法</th> 
   <th align="left">默认值</th> 
   <th align="left">备注</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">newInstance()</td> 
   <td align="left"></td> 
   <td align="left">新建 ChecksumBs 实例(static)</td> 
  </tr> 
  <tr> 
   <td align="left">newInstance(object)</td> 
   <td align="left"></td> 
   <td align="left">新建 ChecksumBs 实例，并且指定待加签的对象(static，建议使用)</td> 
  </tr> 
  <tr> 
   <td align="left">target(Object)</td> 
   <td align="left"></td> 
   <td align="left">指定待加签的对象</td> 
  </tr> 
  <tr> 
   <td align="left">secret(ISecret)</td> 
   <td align="left">DefaultMd5Secret</td> 
   <td align="left">指定加密的策略，默认使用 md5 加密</td> 
  </tr> 
  <tr> 
   <td align="left">sort(ISort)</td> 
   <td align="left">NameAscSort</td> 
   <td align="left">指定排序的策略，默认根据字段的名称正序排列表</td> 
  </tr> 
  <tr> 
   <td align="left">cache(ICache)</td> 
   <td align="left">DefaultFieldListCache</td> 
   <td align="left">指定字段的缓存策略，默认使用本地 map 进行字段信息缓存</td> 
  </tr> 
 </tbody> 
</table>

## 调用核心方法 ##

<table> 
 <thead> 
  <tr> 
   <th align="left">方法</th> 
   <th align="left">返回值</th> 
   <th align="left">备注</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">checksum()</td> 
   <td align="left">String</td> 
   <td align="left">返回加签的结果</td> 
  </tr> 
  <tr> 
   <td align="left">fill()</td> 
   <td align="left">无</td> 
   <td align="left">将上面 checksum 的结果设置到 @Checksum 标识的字段中</td> 
  </tr> 
 </tbody> 
</table>

## 自定义 ##

上述 ISecret/ISort/ICache 都是支持自定义的。

一般只需要重新定义 ISecret 即可。

[github checksum]: https://github.com/houbb/checksum