基於註解的 java 加簽驗籤框架 checksum

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 引導類

用來建立加簽的相關配置及實現。

配置核心方法

方法	默認值	備註
newInstance()		新建 ChecksumBs 實例(static)
newInstance(object)		新建 ChecksumBs 實例，而且指定待加簽的對象(static，建議使用)
target(Object)		指定待加簽的對象
secret(ISecret)	DefaultMd5Secret	指定加密的策略，默認使用 md5 加密
sort(ISort)	NameAscSort	指定排序的策略，默認根據字段的名稱正序排列表
cache(ICache)	DefaultFieldListCache	指定字段的緩存策略，默認使用本地 map 進行字段信息緩存

調用核心方法

方法	返回值	備註
checksum()	String	返回加簽的結果
fill()	無	將上面 checksum 的結果設置到 @Checksum 標識的字段中

自定義

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

通常只須要從新定義 ISecret 便可。