设计模式:组合模式,如何设计实现支持递归遍历的文件系统目录树结构

引入

组合模式跟面向对象对象设计中的“组合关系(通过组合来组织两个类)”,完全是两码事。这里的“组合模式”,主要是用来处理树形结构数据。这里的“数据”,可以简单理解为一组对象集合

正因为其应用场景的特殊性,数据必须能表示成树形结构,这也导致了这种模式在实际开发中不那么常用。但是,一旦数据满足树形结构,应用这种模式就能发挥很大的作用,让代码变得非常简洁

组合模式的原理和实现

在 GoF 的《设计模式》,组合模式定义:将一组数据组织成树形结构,以表示一种“部分-整体”的层次结构

组合让客户端(在很多设计模式书籍中,“客户端”代指代码的使用者。)可以统一单个对象和组合对象的处理逻辑。

举个例子,假设我们有这样一个需求:设计一个类来表示文件系统中的目录,能方便的实现下面功能:

  • 动态的添加、删除某个目录下的子目录或者文件
  • 统计指定目录下的文件个数
  • 统计指定目录下的文件总大小

代码如下。在下面的代码实现中,我们把文件和目录统一用FileSystemNode 类来表示,并且通过 isFile 属性来区分。

public class FileSystemNode {
	private String path;
	private boolean isFile;
	private List<FileSystemNode> subNodes = new ArrayList<>();
	
	public FileSystemNode(String path, boolean isFile) {
		this.path = path;
		this.isFile = isFile;
	}

	public int countNumOfFiles() {
		if (isFile) {
			return 1;
		}
		int numOfFiles = 0;
		for (FileSystemNode fileOrDir : subNodes) {
			numOfFiles += fileOrDir.countNumOfFiles();
		}
		return numOfFiles;
	}
	
	public long countSizeOfFiles() {
		if (isFile) {
		File file = new File(path);
		if (!file.exists()) return 0;
			return file.length();
		}
		long sizeofFiles = 0;
		for (FileSystemNode fileOrDir : subNodes) {
			sizeofFiles += fileOrDir.countSizeOfFiles();
		}
		return sizeofFiles;
	}
	
	public String getPath() {
		return path;
	}
	
	public void addSubNode(FileSystemNode fileOrDir) {
		subNodes.add(fileOrDir);
	}
	
	public void removeSubNode(FileSystemNode fileOrDir) {
		int size = subNodes.size();
		int i = 0;
		for (; i < size; ++i) {
			if (subNodes.get(i).getPath().equalsIgnoreCase(fileOrDir.getPath())) {
				break;
			}
		}
		
		if (i < size) {
			subNodes.remove(i);
		}
	}
}

单纯从功能实现角度来说,上面的代码没有问题,已经实现了我们想要的功能。但是,如果我们开发的时一个大型系统,从扩展性(文件或目录可能对对应不同的操作)、业务建模(文件和目录从业务上是两个概念)、代码的可读性(文件和目录区分对待更加符号人们对业务的认知)的角度来说,我们最好对文件和业务进行区分设计,定义为File和Directory两个类。 重构如下:

public abstract class FileSystemNode {
	protected String path;
	
	public FileSystemNode(String path) {
		this.path = path;
	}
	
	public abstract int countNumOfFiles();
	
	public abstract long countSizeOfFiles();
	
	public String getPath() {
		return path;
	}
}

public class File extends FileSystemNode {
	public File(String path) {
		super(path);
	}
	
	@Override
	public int countNumOfFiles() {
		return 1;
	}
	
	@Override
	public long countSizeOfFiles() {
		java.io.File file = new java.io.File(path);
		if (!file.exists()) return 0;
		return file.length();
	}
}

public class Directory extends FileSystemNode {
	private List<FileSystemNode> subNodes = new ArrayList<>();
	
	public Directory(String path) {
		super(path);
	}
	
	@Override
	public int countNumOfFiles() {
		int numOfFiles = 0;
		for (FileSystemNode fileOrDir : subNodes) {
			numOfFiles += fileOrDir.countNumOfFiles();
		}
		return numOfFiles;
	}
	
	@Override
	public long countSizeOfFiles() {
		long sizeofFiles = 0;
		for (FileSystemNode fileOrDir : subNodes) {
			sizeofFiles += fileOrDir.countSizeOfFiles();
		}
		return sizeofFiles;
	}
	
	public void addSubNode(FileSystemNode fileOrDir) {
		subNodes.add(fileOrDir);
	}
	
	public void removeSubNode(FileSystemNode fileOrDir) {
		int size = subNodes.size();
		int i = 0;
		for (; i < size; ++i) {
			if (subNodes.get(i).getPath().equalsIgnoreCase(fileOrDir.getPath())) {
				break;
			}
		}
		if (i < size) {
			subNodes.remove(i);
		}
	}
}

文件和目录类都设计好了,我们来看,如何用它们来表示一个文件系统中的目录树结构。具体的代码示例如下所示:

public class Demo {
	public static void main(String[] args) {
		/**
		* /
		* /wz/
		* /wz/a.txt
		* /wz/b.txt
		* /wz/movies/
		* /wz/movies/c.avi
		* /xzg/
		* /xzg/docs/
		* /xzg/docs/d.txt
		*/
		Directory fileSystemTree = new Directory("/");
		Directory node_wz = new Directory("/wz/");
		Directory node_xzg = new Directory("/xzg/");
		fileSystemTree.addSubNode(node_wz);
		fileSystemTree.addSubNode(node_xzg);
		File node_wz_a = new File("/wz/a.txt");
		File node_wz_b = new File("/wz/b.txt");
		Directory node_wz_movies = new Directory("/wz/movies/");
		node_wz.addSubNode(node_wz_a);
		node_wz.addSubNode(node_wz_b);
		node_wz.addSubNode(node_wz_movies);
		File node_wz_movies_c = new File("/wz/movies/c.avi");
		node_wz_movies.addSubNode(node_wz_movies_c);
		Directory node_xzg_docs = new Directory("/xzg/docs/");
		node_xzg.addSubNode(node_xzg_docs);
		File node_xzg_docs_d = new File("/xzg/docs/d.txt");
		node_xzg_docs.addSubNode(node_xzg_docs_d);
		System.out.println("/ files num:" + fileSystemTree.countNumOfFiles());
		System.out.println("/wz/ files num:" + node_wz.countNumOfFiles());
	}
}

我们对照者这个例子,再重新看一下组合模式的定义:将一组对象(文件和目录)组织成树形结构,以表示一种“部分-整体”的层次结构(目录和子目录的嵌套结构)。组合模式让客户端可以统一单个对象(文件)和组合对象(目录)的处理逻辑(递归遍历)。

实际上,刚才讲的这种组合模式的设计思路,与其说是一种设计模式,倒不如说是对业务场景的一种数据结构和算法的抽象。其中,数据可以表示成树这种数据结构,业务需求可以通过再树上递归遍历算法实现。

问题:countNumOfFiles() 和 countSizeOfFiles() 这两个函数实现的效率并不高,因为每次调用它们的时候,都要重新遍历一遍子树。有没有什么办法可以提高这两个函数的执行效率呢

回答:实质是"递归代码要警惕重复计算"问题!可以用散列表存储每个(path,size),通过路径直接返回对应的size,删除或者添加的时候,维护这个size即可。

组合模式的应用场景举例

刚刚我们讲了文件系统的例子,对于组合模式,这里再举一个例子。搞懂了这两个例子,你基本上就算掌握了组合模式。在实际的项目中,遇到类似的可以表示成树形结构的业务场景,你只要“照葫芦画瓢”去设计就可以了

假设我们在开发一个 OA 系统(办公自动化系统)。公司的组织结构包含部门和员工两种数据类型。其中,部门又可以包含子部门和员工。在数据库中的表结构如下所示:
在这里插入图片描述

我们希望在内存中改建出整个公司的人员架构图(部门、子部门、员工的隶属关系),并且提供接口计算出部分的薪资成本(隶属于这个部门的所有员工的薪资和)

部门包含子部门和员工,这是一种嵌套结构,可以表示成树这种数据结构。计算每个部分的薪资开支这样一个需求,可以通过在树上的遍历算法来实现。所以,从这个角度来看,这个应用场景可以使用组合模式来设计和实现。

代码如下。其中,HumanResource 是部门类(Department)和员工类(Employee)抽象出来的父类,为的是能统一薪资的处理逻辑。Demo 中的代码负责从数据库中读取数据并在内存中构建组织架构图。

public abstract class HumanResource {
	protected long id;
	protected double salary;
	
	public HumanResource(long id) {
		this.id = id;
	}
	
	public long getId() {
		return id;
	}
	
	public abstract double calculateSalary();
}

public class Employee extends HumanResource {
	public Employee(long id, double salary) {
		super(id);
		this.salary = salary;
	}
	
	@Override
	public double calculateSalary() {
		return salary;
	}
}
public class Department extends HumanResource {
	private List<HumanResource> subNodes = new ArrayList<>();
	
	public Department(long id) {
		super(id);
	}
	
	@Override
	public double calculateSalary() {
		double totalSalary = 0;
		for (HumanResource hr : subNodes) {
			totalSalary += hr.calculateSalary();
		}
		this.salary = totalSalary;
		return totalSalary;
	}
	public void addSubNode(HumanResource hr) {
		subNodes.add(hr);
	}
}

// 构建组织架构的代码
public class Demo {
	private static final long ORGANIZATION_ROOT_ID = 1001;
	private DepartmentRepo departmentRepo; // 依赖注入
	private EmployeeRepo employeeRepo; // 依赖注入
	
	public void buildOrganization() {
		Department rootDepartment = new Department(ORGANIZATION_ROOT_ID);
		buildOrganization(rootDepartment);
	}
	
	private void buildOrganization(Department department) {
		List<Long> subDepartmentIds = departmentRepo.getSubDepartmentIds(department
		for (Long subDepartmentId : subDepartmentIds) {
			Department subDepartment = new Department(subDepartmentId);
			department.addSubNode(subDepartment);
			buildOrganization(subDepartment);
		}
		List<Long> employeeIds = employeeRepo.getDepartmentEmployeeIds(department.g
		for (Long employeeId : employeeIds) {
			double salary = employeeRepo.getEmployeeSalary(employeeId);
			department.addSubNode(new Employee(employeeId, salary));
		}
	}
}

我们再拿组合模式的定义跟这个例子对照一下:“将一组对象(员工和部门)组织成树形结构,以表示一种‘部分 - 整体’的层次结构(部门与子部门的嵌套结构)。组合模式让客户端可以统一单个对象(员工)和组合对象(部门)的处理逻辑(递归遍历)。”

总结

组合模式的设计思路,与其说是一种设计模式,倒不如说是对业务场景的一种数据结构和算法的抽象。其中,数据可以表示成树这种数据结构,业务需求可以通过在树上的递归遍历算法来实现。

组合模式,将一组对象组织成树形结构,将单个对象和组合对象都看着树种的节点,以统一处理逻辑,并且它利用树形结构的特点,递归的处理每个子树,依次简化代码实现。使用组合模式的前提是,你的业务场景必须能够表示成树形结构。所以,组合模式的应用场景比较局限,并不是一种很常用的设计模式

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值