十二、树结构的实际应用—赫夫曼树

1、赫夫曼树

1.1 基本介绍

• 给定 n 个权值作为 n 个叶子节点，构造一棵二叉树，若该树的带权路径长度（wpl）达到最小，称这样的二叉树为最优二叉树，也称哈夫曼树（Huffman Tree），有的翻译为霍夫曼树、赫夫曼树
• 赫夫曼树是带权路径长度最短的树，权值较大的节点离根节点较近

1.2 重要概念

• 路径和路径长度：在一棵树中，从一个节点往下可以达到的孩子或者孙子节点之间的通路，称为路径。通路中分支的数目称为路径长度。若规定根节点的层数为1，则从根节点到第 L 层节点的路径长度为 L-1
• 节点的权及带权路径长度：若将树中节点赋给一个有着某种含义的数值，则这个数值称为该节点的权。节点的带权路径长度为：从根节点到该节点之间的路径长度与该节点的权的乘积
• 树的带权路径长度：树的带权路径长度规定为所有叶子节点的带权路径长度之和，记为 WPL（Weighted Path Length）。权值越大的节点离根节点越近的二叉树才是最优二叉树

下面是一些 WPL 计算的例子：（长度为59的是最优二叉树）

1.3 赫夫曼树构建思路图解

要求：给你一个数列 {13, 7, 8, 29, 6, 1} ，要求转化为一颗赫夫曼树

构成赫夫曼树的步骤：

• 将数列从小到大进行排序，每个数据都是一个节点，每个节点可以看成是一棵最简单的二叉树
• 取出根节点权值最小的两棵二叉树
• 组成一棵新的二叉树，该新的二叉树的根节点的权值是前面两棵二叉树根节点的权值和
• 再将这棵新的二叉树。以根节点的权值大小，再次排序，不断重复这四个步骤（上面三个+当前一个），直到数列中所有的数据都被处理，就得到了一颗赫夫曼树

下面是示意图：

1.4 赫夫曼树代码实现

public class HuffmanTreeDemo {

	public static void main(String[] args) {
		 int arr[]=new int[]{13,7,8,3,29,6,1};
		 Node root = createHuffmanTree(arr);
		 preSort(root);
	}
	
	public static void preSort(Node root) {
		if (root != null) {
			root.preSort();
		}else {
			 System.out.println("该赫夫曼树是空树");
		}
	}
	
	public static Node createHuffmanTree(int[] arr) {
		//第一步：为了操作方便：
		/**
		 * 1、遍历arr数组
		 * 2、将arr的每个元素构建成一个Node
		 * 3、将Node放到ArrayList中
		 */
		List<Node> nodes = new ArrayList<Node>();
		for (int value : arr) {
			nodes.add(new Node(value));
		}
		
		while (nodes.size() > 1) {//这个主要是因为nodes一直在remove，到最后就剩一个节点。
			Collections.sort(nodes);
			
			//取出根节点权值最小的两个二叉树
            //（1）取出权值最小的节点（二叉树），一个节点也可以看作是一个最简单的二叉树
			Node leftNode = nodes.get(0);
			 //（2）取出权值第二小的节点（二叉树）
			Node rightNode = nodes.get(1);
			 //（3）构建一个新的二叉树
			Node parent = new Node(leftNode.value + rightNode.value);//左右节点权值的加和才是父节点
			parent.left = leftNode;
			parent.right = rightNode;
			 //（4）从ArrayList中删除处理过的二叉树
			nodes.remove(leftNode);
			nodes.remove(rightNode);
			//(5)将parent加入nodes
			nodes.add(parent);
		}
		
		  //返回哈夫曼树的root节点，其实最后也就剩一个节点了
        return nodes.get(0);

	}

}

class Node implements Comparable<Node>{
	
	int value; //节点权值
	Node left; //指向左子节点
	Node right; //指向右子节点
	
	public Node(int value) {
		this.value = value;
	}
	
	@Override
	public String toString() {
		return "Node [value=" + value + "]";
	}

	public void preSort() {
		System.out.println(this);
		if (this.left != null) {
			this.left.preSort();
		}
		if (this.right != null) {
			this.right.preSort();
		}
	}

	@Override
	public int compareTo(Node o) {
		// 从小到大排序
		return this.value - o.value;
	}
	
}

2、赫夫曼编码

2.1 基本介绍

• 赫夫曼编码也翻译为哈夫曼编码（Huffman Coding），又称霍夫曼编码，是一种编码方式，属于一种程序算法
• 赫夫曼编码是哈夫曼树在电讯通信中的经典的应用之一
• 赫夫曼编码广泛地用于数据文件压缩。其压缩率通常在20%~90%之间
• 赫夫曼编码是可变字长编码（VLC）地一种，Huffman 于 1952 年提出一种编码方法，称之为最佳编码

2.2 原理剖析

通信领域中信息地处理方式1：定长编码
[参考ASCII码表]

通信领域中信息地处理方式2：变长编码

通信领域中信息地处理方式3：赫夫曼编码

最后得到的赫夫曼树为：


此编码需满足前缀编码，即字符的编码都不能是其他字符编码的前缀。不然会造成匹配的多义性，赫夫曼编码是无损处理方案。
注意，这个赫夫曼树根据排序方法不同，也可能不太一样，这样对应赫夫曼编码也不完全一样，但是 WPL 是一样的，都是最小的，最后生成的赫夫曼编码的长度是一样的，

2.3 最佳实践：数据压缩和解压

1) 数据压缩

2）数据解压

3）文件压缩

思路：读取文件—>得到赫夫曼编码表—>完成压缩

4）文件解压

思路：读取压缩文件（数据和）—>完成解压

5）赫夫曼编码压缩文件注意事项

• 如果文件本身就是经过压缩处理的，那么使用赫夫曼编码再压缩效果不会有明显变化，比如视频、PPT等文件
• 赫夫曼编码是按字节来处理的，因此可以处理所有的文件
• 如果一个文件中的内容，重复的数据不多，压缩效果也不会很明显

2.4 代码实现

public class HuffmanCodeDemo {
	public static void main(String[] args) {
		String content = "i like like like java do you like a java";
		byte[] contentBytes = content.getBytes();
		System.out.println(contentBytes.length); // 40

		byte[] huffmanCodeBytes = huffmanZip(contentBytes);
		System.out.println("huffmanCodes=" + Arrays.toString(huffmanCodeBytes));

		byte[] sourseBytes = decode(huffmanCodes, huffmanCodeBytes);
		System.out.println("原来的字符串是：" + new String(sourseBytes));

		String srcFile = "d://1.txt";
		String dstFile = "d://2.zip";
		zipFile(srcFile, dstFile);
		System.out.println("压缩文件成功");
		String zipFile = "d://2.zip";
		String data = "d://src.docx";
		unZipFile(zipFile,data);
		System.out.println("解压文件成功");

	}

	/**
	 * 文件解压
	 * 
	 * @param zipFile 待解压文件路径
	 * @param dstFile 解压后文件存放路径
	 */
	private static void unZipFile(String zipFile, String dstFile) {
		// 定义文件输入流
		InputStream is = null;
		// 定义对象输入流
		ObjectInputStream ois = null;
		// 定义文件的输出流
		OutputStream os = null;
		try {
			// 创建文件输入流
			is = new FileInputStream(zipFile);
			// 创建一个和is相关联的对象输入流
			ois = new ObjectInputStream(is);
			// 读取byte数组huffmanBytes
			byte[] huffmanBytes = (byte[]) ois.readObject();
			// 读取赫夫曼编码表
			Map<Byte, String> huffmanCodes = (Map<Byte, String>) ois.readObject();
			// 解码
			byte[] bytes = decode(huffmanCodes, huffmanBytes);
			// 将bytes数组写入到募兵文件
			os = new FileOutputStream(dstFile);
			os.write(bytes);
		} catch (Exception e) {
			System.out.println(e);
		} finally {
			try {
				ois.close();
				is.close();
				os.close();
			} catch (IOException e) {
				e.printStackTrace();
			}
		}
	}

	/**
	 * 文件压缩
	 * 
	 * @param srcFile 待压缩文件路径
	 * @param dstFile 压缩后文件存放路径
	 */
	private static void zipFile(String srcFile, String dstFile) {
		FileInputStream fis = null;
		FileOutputStream fos = null;
		ObjectOutputStream oos = null;

		try {
			// 创建文件的输入流
			fis = new FileInputStream(srcFile);
			// 创建一个和源文件大小一样的byte[]
			byte[] b = new byte[fis.available()];
			fis.read(b);
			byte[] huffmanBytes = huffmanZip(b);
			// 创建文件的输出流，存放压缩文件
			fos = new FileOutputStream(dstFile);
			oos = new ObjectOutputStream(fos);
			// 把赫夫曼编码后的字节数组写入压缩文件
			oos.write(huffmanBytes);
			// 这里以对象流的方式写入赫夫曼编码，是为了我们以后恢复文件时使用
			// 注意一定要把赫夫曼编码写入压缩文件
			oos.writeObject(huffmanBytes);

		} catch (Exception e) {
			System.out.println(e.getMessage());
		} finally {
			try {
				fis.close();
				fos.close();
				oos.close();
			} catch (IOException e) {
				System.out.println(e.getMessage());
			}
		}
	}

	/**
	 * 将一个byte转成一个二进制的字符串
	 * 
	 * @param flag 是否补高位
	 * @param b
	 */
	private static String byteToBitString(boolean flag, byte b) {
		int temp = b;
		if (flag) {
			temp |= 256;
		}
		String str = Integer.toBinaryString(temp);
		if (flag) {
			return str.substring(str.length() - 8);
		} else {
			return str;
		}
	}

	/**
	 * 解码
	 * 
	 * @param huffmanCodes
	 * @param huffmanBytes
	 * @return
	 */
	private static byte[] decode(Map<Byte, String> huffmanCodes, byte[] huffmanBytes) {
		// 1.先得到huffmanBytes 对应的二进制的字符串
		StringBuilder stringBuilder = new StringBuilder();
		// 将byte数组转成二进制的字符串
		for (int i = 0; i < huffmanBytes.length; i++) {
			byte b = huffmanBytes[i];
			// 判断最后一个字节
			boolean flag = (i == huffmanBytes.length - 1);
			stringBuilder.append(byteToBitString(!flag, b));
		}
		// 把字符串按照指定的赫夫曼编码进行编码
		Map<String, Byte> map = new HashMap<String, Byte>();
		for (Map.Entry<Byte, String> entry : huffmanCodes.entrySet()) {
			map.put(entry.getValue(), entry.getKey());
		}
		System.out.println("map=" + map);

		List<Byte> list = new ArrayList<Byte>();
		for (int i = 0; i < stringBuilder.length();) {
			int count = 1;// 计数器
			boolean flag = true;
			Byte b = null;
			while (flag) {
				String key = stringBuilder.substring(i, i + count);
				b = map.get(key);
				if (b == null) {
					// 说明没有匹配到
					count++;
				} else {
					flag = false;
				}
			}
			list.add(b);
			i += count;
		}

		byte[] b = new byte[list.size()];
		for (int i = 0; i < b.length; i++) {
			b[i] = list.get(i);
		}
		return b;
	}

	/**
	 * 封装 赫夫曼压缩
	 * 
	 * @param bytes
	 * @return
	 */
	private static byte[] huffmanZip(byte[] bytes) {
		List<Node> nodes = getNodes(bytes);
		Node huffmanTreeRoot = createHuffmanTree(nodes);

		getCodes(huffmanTreeRoot, "", stringBuilder);
		System.out.println("哈夫曼编码表：" + huffmanCodes);
		byte[] huffmanCodeBytes = zip(bytes, huffmanCodes);
		return huffmanCodeBytes;
	}

	/**
	 * 将字符串对应的byte[]数组，通过生成的荷夫曼编码表，返回一个赫夫曼编码压缩后的byte[]
	 * 
	 * @param bytes
	 * @param huffmanCode
	 */
	private static byte[] zip(byte[] bytes, Map<Byte, String> huffmanCode) {
		StringBuilder stringBuilder = new StringBuilder();
		for (byte b : bytes) {
			stringBuilder.append(huffmanCode.get(b));
		}

		int length;
		if (stringBuilder.length() % 8 == 0) {
			length = stringBuilder.length();
		} else {
			length = stringBuilder.length() / 8 + 1;
		}

		// 存储压缩后的byte数组
		byte[] huffmanCodeBytes = new byte[length];
		int index = 0;
		for (int i = 0; i < stringBuilder.length(); i += 8) {
			String strByte;
			if (i + 8 > stringBuilder.length()) {
				strByte = stringBuilder.substring(i);
			} else {
				strByte = stringBuilder.substring(i, i + 8);
			}
			huffmanCodeBytes[index++] = (byte) Integer.parseInt(strByte, 2);
		}

		return huffmanCodeBytes;
	}

	static Map<Byte, String> huffmanCodes = new HashMap<Byte, String>();
	static StringBuilder stringBuilder = new StringBuilder();

	/**
	 * 生产哈夫曼树对应的哈夫曼编码
	 * 
	 * @param node
	 * @param code
	 * @param stringBuilder
	 */
	private static void getCodes(Node node, String code, StringBuilder stringBuilder) {
		StringBuilder stringBuilder2 = new StringBuilder(stringBuilder);
		stringBuilder2.append(code);
		if (node != null) {
			if (node.data == null) { // 是非叶子节点
				// 向左递归
				getCodes(node.left, "0", stringBuilder2);
				// 向右递归
				getCodes(node.right, "1", stringBuilder2);

			} else {
				// 说明是叶子节点
				huffmanCodes.put(node.data, stringBuilder2.toString());
			}

		}
	}

	private static List<Node> getNodes(byte[] bytes) {
		List<Node> nodes = new ArrayList<Node>();
		Map<Byte, Integer> counts = new HashMap<>();

		for (byte b : bytes) {
			Integer count = counts.get(b);
			if (count == null) {
				counts.put(b, 1);
			} else {
				counts.put(b, count + 1);
			}
		}

		for (Map.Entry<Byte, Integer> entry : counts.entrySet()) {
			nodes.add(new Node(entry.getKey(), entry.getValue()));
		}
		return nodes;

	}

	// 创建赫夫曼树
	public static Node createHuffmanTree(List<Node> nodes) {
		while (nodes.size() > 1) {
			Collections.sort(nodes);
			Node leftNode = nodes.get(0);
			Node rightNode = nodes.get(1);
			Node parent = new Node(null, leftNode.weight + rightNode.weight);
			parent.left = leftNode;
			parent.right = rightNode;
			nodes.remove(leftNode);
			nodes.remove(rightNode);
			nodes.add(parent);
		}
		return nodes.get(0);
	}

}

class Node implements Comparable<Node> {
	Byte data; // 存放数据 比如 'a' =>97
	int weight;// 权值 表示字符出现的次数
	Node left;
	Node right;

	public Node(Byte data, int weight) {
		this.data = data;
		this.weight = weight;
	}

	@Override
	public String toString() {
		return "Node [data=" + data + ", weight=" + weight + "]";
	}

	public void preOrder() {
		System.out.println(this);
		if (this.left != null) {
			this.left.preOrder();
		}
		if (this.right != null) {
			this.right.preOrder();
		}
	}

	@Override
	public int compareTo(Node o) {
		return this.weight - o.weight;
	}

}