Apache Commons Codec 与消息摘要算法(hash算法)

首先我们要明白 Codec 是什么含义。它是 Coder + decoder = Codec，也就是编码器解码器。即是编码器，也是解码器。

官网地址：http://commons.apache.org/proper/commons-codec/

Apache Commons Codec (TM) software provides implementations of common encoders and decoders such as Base64, Hex, Phonetic and URLs.

主要提供的是 Base64, Hex, Phonetic and URLs 等的编码和解密。

Impetus

Codec was formed as an attempt to focus development effort on one definitive implementation of the Base64 encoder. At the time of Codec's proposal, there were approximately 34 different Java classes that dealt with Base64 encoding spread over the Foundation's CVS repository. Developers in the Jakarta Tomcat project had implemented an original version of the Base64 codec which had been copied by the Commons HttpClient and Apache XML project's XML-RPC subproject. After almost one year, the two forked versions of Base64 had significantly diverged from one another. XML-RPC had applied numerous fixes and patches which were not applied to the Commons HttpClient Base64. Different subprojects had differing implementations at various levels of compliance with the RFC 2045.

Out of that confusing duplication of effort sprang this simple attempt to encourage code reuse among various projects. While this package contains a abstract framework for the creation of encoders and decoders, Codec itself is primarily focused on providing functional utilities for working with common encodings.

建立项目的原因是：促进 Base64 等编码算法的标准化，统一化。因为 Base64 有很多不同的实现，互不兼容。

其实我们使用 Apache Commons Codec，主要原因并不是使用它的 编码解码的功能，一般我们是看中它实现了很完整的“消息摘要”算法，也称hash算法。

Hex，Base64等待编码解码功能只是辅助于“消息摘要”算法而已。

消息摘要算法的实现主要是其中的：DigestUtils

static MessageDigest     getDigest(String algorithm)　　Returns a MessageDigest for the given algorithm.
static MessageDigest     getMd2Digest() 　　　　　　　　　Returns an MD2 MessageDigest.
static MessageDigest     getMd5Digest()　　　　　　　　　 Returns an MD5 MessageDigest.
static MessageDigest     getSha1Digest()　　　　　　　　　Returns an SHA-1 digest.
static MessageDigest     getSha256Digest()　　　　　　　　Returns an SHA-256 digest.
static MessageDigest     getSha384Digest()　　　　　　　　Returns an SHA-384 digest.
static MessageDigest     getSha512Digest()　　　　　　　　Returns an SHA-512 digest.
static byte[]     md2(byte[] data)　　　　　　Calculates the MD2 digest and returns the value as a 16 element byte[].
static byte[]     md2(InputStream data)　　　Calculates the MD2 digest and returns the value as a 16 element byte[].
static byte[]     md2(String data)　　　　　　Calculates the MD2 digest and returns the value as a 16 element byte[].
static String     md2Hex(byte[] data)　　　　Calculates the MD2 digest and returns the value as a 32 character hex string.
static String     md2Hex(InputStream data)　Calculates the MD2 digest and returns the value as a 32 character hex string.
static String     md2Hex(String data)　　　　Calculates the MD2 digest and returns the value as a 32 character hex string.
static byte[]     md5(byte[] data)　　　　　 Calculates the MD5 digest and returns the value as a 16 element byte[].
static byte[]     md5(InputStream data)　　 Calculates the MD5 digest and returns the value as a 16 element byte[].
static byte[]     md5(String data)　　　　　 Calculates the MD5 digest and returns the value as a 16 element byte[].
static String     md5Hex(byte[] data)　　　 Calculates the MD5 digest and returns the value as a 32 character hex string.
static String     md5Hex(InputStream data) Calculates the MD5 digest and returns the value as a 32 character hex string.
static String     md5Hex(String data)      Calculates the MD5 digest and returns the value as a 32 character hex string.
static byte[]     sha1(byte[] data)　　　　 Calculates the SHA-1 digest and returns the value as a byte[].

static byte[]     sha1(InputStream data)　　Calculates the SHA-1 digest and returns the value as a byte[].
static byte[]     sha1(String data)　　　　  Calculates the SHA-1 digest and returns the value as a byte[].
static String     sha1Hex(byte[] data)　　  Calculates the SHA-1 digest and returns the value as a hex string.
static String     sha1Hex(InputStream data)　　Calculates the SHA-1 digest and returns the value as a hex string.
static String     sha1Hex(String data)　　　　Calculates the SHA-1 digest and returns the value as a hex string.
static byte[]     sha256(byte[] data)　　　　 Calculates the SHA-256 digest and returns the value as a byte[].
static byte[]     sha256(InputStream data)　　Calculates the SHA-256 digest and returns the value as a byte[].
static byte[]     sha256(String data)　　　　  Calculates the SHA-256 digest and returns the value as a byte[].
static String     sha256Hex(byte[] data)　　  Calculates the SHA-256 digest and returns the value as a hex string.
static String     sha256Hex(InputStream data)　　Calculates the SHA-256 digest and returns the value as a hex string.
static String     sha256Hex(String data)　　　　  Calculates the SHA-256 digest and returns the value as a hex string.
static byte[]     sha384(byte[] data)　　　　     Calculates the SHA-384 digest and returns the value as a byte[].
static byte[]     sha384(InputStream data)　　Calculates the SHA-384 digest and returns the value as a byte[].
static byte[]     sha384(String data)　　　　  Calculates the SHA-384 digest and returns the value as a byte[].
static String     sha384Hex(byte[] data)　　  Calculates the SHA-384 digest and returns the value as a hex string.
static String     sha384Hex(InputStream data)　　Calculates the SHA-384 digest and returns the value as a hex string.
static String     sha384Hex(String data)　　　　 Calculates the SHA-384 digest and returns the value as a hex string.
static byte[]     sha512(byte[] data)　　　　　　 Calculates the SHA-512 digest and returns the value as a byte[].
static byte[]     sha512(InputStream data)　　　　Calculates the SHA-512 digest and returns the value as a byte[].
static byte[]     sha512(String data)　　　　     Calculates the SHA-512 digest and returns the value as a byte[].
static String     sha512Hex(byte[] data)　　     Calculates the SHA-512 digest and returns the value as a hex string.
static String     sha512Hex(InputStream data)　　Calculates the SHA-512 digest and returns the value as a hex string.
static String     sha512Hex(String data)　　     Calculates the SHA-512 digest and returns the value as a hex string.

static MessageDigest  updateDigest(MessageDigest messageDigest, byte[] valueToDigest)　Updates the given MessageDigest.
static MessageDigest  updateDigest(MessageDigest digest, InputStream data) Reads through an InputStream and updates the digest for the data
static MessageDigest  updateDigest(MessageDigest messageDigest, String valueToDigest) Updates the given MessageDigest.

针对上面怎么多和“摘要算法”相关的函数，其实他们的存在是为了方便使用。

我们看到这些函数的参数分为了三种：byte[], InputStream, String，为了方便使用。消息摘要算法分为了 MD 系列和 SHA系列。

其实区分他们的最重要的方法，是看他们的返回值类型：

1）如果返回类型为 byte[]，那么他们是 加密函数，或者说Hash. 也就是 Calculates the digest，计算摘要的功能。

2）如果返回类型是 String, 那么他们是 既包含了加密的过程，也就是计算摘要的过程，同时还将计算的结果转换成16进制编码的String，以利于存储结果和比较结果。一步到位。

3）返回MessageDigest的函数有两类，他们都是为了实现：加盐的多次迭代的“消息摘要”算法。下面看一个例子：

import java.security.MessageDigest;

import org.apache.commons.codec.digest.DigestUtils;
import org.apache.commons.codec.binary.Hex;
import org.apache.shiro.crypto.hash.SimpleHash;
import org.junit.Test;

public class CodecTest {
    @Test
    public void test(){
         MessageDigest digest = DigestUtils.getSha256Digest();
         digest.update("salt".getBytes());
         byte[] rs = digest.digest("just a test".getBytes());
         int iterations = 10 - 1;
         for (int i = 0; i < iterations; i++) {
                digest.reset();
                rs = digest.digest(rs);
         }

         System.out.println(Hex.encodeHex(rs));
         System.out.println(new SimpleHash("sha-256", "just a test", "salt", 10).toString());

         MessageDigest digest2 = DigestUtils.getSha256Digest();
         DigestUtils.updateDigest(digest2, "salt");
         byte[] rs2 = digest2.digest("just a test".getBytes());
         for (int i = 0; i < 9; i++) {
                digest2.reset();
                rs2 = digest2.digest(rs2);
         }
         System.out.println(Hex.encodeHex(rs2));
    }
}

输出结果：

8cfa3262a7dd6af87f9c60fabd56eafd2d3861164b86b0afa6c103fed63ead49
8cfa3262a7dd6af87f9c60fabd56eafd2d3861164b86b0afa6c103fed63ead49
8cfa3262a7dd6af87f9c60fabd56eafd2d3861164b86b0afa6c103fed63ead49

上面使用了三种方法来实现：对字符串"just a test" 利于算法 "sha-256"，盐为"salt"，迭代次数为10，的算法。也演示了 Apache Commons Codec 中DigestUtils 和 Hex 的用法。

关于为什么要进行 Hex 16进制编码及相关问题，参见 加密解密基础问题：字节数组和字符串的相互转换

Hex 类在 16进制字符串和byte[]以及原始String的转换：

    @Test
    public void testHex() throws DecoderException{
        String str = "hello, 世界。";
        char[] c = Hex.encodeHex(str.getBytes());
        String hexStr = new String(c);
        System.out.println(hexStr);

        hexStr = Hex.encodeHexString(str.getBytes());
        System.out.println(hexStr);

        String originalStr = new String(Hex.decodeHex(hexStr.toCharArray()));
        System.out.println(originalStr);
    }

结果：

68656c6c6f2c20e4b896e7958ce38082
68656c6c6f2c20e4b896e7958ce38082
hello, 世界。