设计模式之 Proxy - 代理模式

Proxy模式也叫代理模式，是由GoF提出的23种软件设计模式的一种。本文介绍设计模式中的装饰（Proxy）模式的概念，用法，以及实际应用中怎么样使用代理模式进行开发。

Proxy模式的概念

Proxy模式是构造型的设计模式之一，它可以为其他对象提供一种代理（Proxy）以控制对这个对象的访问。
所谓代理，是指具有与代理元（被代理的对象）具有相同的接口的类，客户端必须通过代理与被代理的目标类交互，而代理一般在交互的过程中（交互前后），进行某些特别的处理。
根据这些“特别处理”的不同，有以下几种常见的代理模式：
- Remote proxy：远程代理。该代理可以让客户端透明地引用一个存在于不同地址空间（远程或本地）的对象。
- Virtual proxy：虚拟代理。该代理允许一个对象只有在真正被用到时才被创建。
- Copy-on-write proxy：对象拷贝延迟代理。该代理可以延迟一个对象的拷贝（clone）操作到客户调用里，它是virtual proxy模式的一种特殊情况。一般来说，对象的深度克隆是一个高开销的动作，该代理可以让这个动作延迟，只有对象被用到的时候才被克隆。
- Protection (access) proxy：访问保护代理。该代理可以在访问一个对象时附加一些检查操作，比如权限验证等。
- Cache proxy：缓存代理。主要为那些创建时高开销的对象提供缓存，以供多客户端共享。
- Firewall proxy：防火墙代理。保护目标对象不受某些不良客户端的侵害。
- Synchronization proxy：为非同步的目标对象提供并发控制。
- Smart reference proxy：当一个对象被引用时提供某些额外的操作。比如对象被引用时，记录对象被引用的次数等。


Proxy模式的类图描述：

[出自：wikimedia.org]

Subject
被代理的类的接口。
Proxy
代理类。该代理类实现了Subject接口。
RealSubject
代理元，即被代理的目标类。它实现了Subject接口。

Proxy模式的应用范例

下面，我们实现一个Protection (access) proxy：
在该范例中，我们模拟了一个现实应用中使用代理控制对数据库表FILE_TBL的操作。当一个用户具有足够的权限时，则可以进行修改删除等操作。否则，打印权限不够的错误信息。
文件一览：
Client
    测试类
FileTbl
    与数据库表FILE_TBL相对应的数据类
Permission
    权限控制
FileTblDao
    操作数据库表FILE_TBL的DAO接口
FileTblDaoImpl
    操作数据库表FILE_TBL的DAO接口的一个标准实现
FileTblDaoProxy
    FileTblDaoImpl的一个代理类。通过该代理类，控制用户进行不同的操作

public class Client {
    /**
     * for test
     */
    public static void main(String[] args) {
        //只读权限的用户
        Permission searchPermission = new Permission(Permission.PERMISSION.SEARCH);
        FileTblDao searchDao = new FileTblDaoProxy(searchPermission);
        FileTbl fileTbl = searchDao.getFile("file01");
        //只读权限的用户修改文件
        searchDao.updateFile(fileTbl);
        
        //全权限的用户
        Permission allPermission = new Permission(Permission.PERMISSION.ALL);
        FileTblDao allDao = new FileTblDaoProxy(allPermission);
        //全权限的用户修改文件
        allDao.updateFile(fileTbl);
    }

}


/**
* Subject
* 操作文件表的DAO
*/
interface FileTblDao {
    public void deleteFile(FileTbl fileTbl);
    public void updateFile(FileTbl fileTbl);
    public void saveFile(FileTbl fileTbl);
    public FileTbl getFile(String fileId);
}

/**
* RealSubject
* 操作文件表的DAO的一个标准实现
*/
class FileTblDaoImpl implements FileTblDao {

    public void deleteFile(FileTbl fileTbl) {
        System.out.println("delete file:" + fileTbl.getId());        
    }

    public void updateFile(FileTbl fileTbl) {
        System.out.println("update file:" + fileTbl.getId());
    }

    public void saveFile(FileTbl fileTbl) {
        System.out.println("save file:" + fileTbl.getId());
    }

    public FileTbl getFile(String fileId) {
        return new FileTbl(fileId);
    }
    
}

/**
* Proxy
* 操作文件表的DAO代理。该DAO根据用户权限判断是否进行修改，删除文件等操作。
* 如果有足够的权限，则调用FileTblDaoImpl相关方法操作文件
*
*/
class FileTblDaoProxy implements FileTblDao {
    FileTblDao fileTblDao;
    Permission permission;
    
    public FileTblDaoProxy(Permission permission) {
        if (fileTblDao == null) {
            fileTblDao = new FileTblDaoImpl();
        }
        
        this.permission = permission;
    }
    
    public void deleteFile(FileTbl fileTbl) {
        if (Permission.PERMISSION.ALL.equals(permission.getLevel())) {
            fileTblDao.deleteFile(fileTbl);
        } else {
            System.out.println("no permission to delete file:" + fileTbl.getId());
        }
    }

    public void updateFile(FileTbl fileTbl) {
        
        if (Permission.PERMISSION.ALL.equals(permission.getLevel())) {
            fileTblDao.updateFile(fileTbl);
        } else {
            System.out.println("no permission to update file:" + fileTbl.getId());
        }
    }

    public void saveFile(FileTbl fileTbl) {
        if (Permission.PERMISSION.ALL.equals(permission.getLevel())) {
            fileTblDao.saveFile(fileTbl);
        } else {
            System.out.println("no permission to save file:" + fileTbl.getId());
        }
    }

    public FileTbl getFile(String fileId) {
        return fileTblDao.getFile(fileId);
    }
}


//文件表类
class FileTbl {
    private String id;

    public FileTbl(String id) {
        this.id = id;
    }
    public String getId() {
        return id;
    }

    public void setId(String id) {
        this.id = id;
    }
    
}

//权限控制类
class Permission {
    public static enum PERMISSION {
        ALL,
        SEARCH
    }
    
    private PERMISSION level;
    
    public Permission(PERMISSION level) {
        this.level = level;
    }

    public PERMISSION getLevel() {
        return level;
    }
}

执行Client，输出结果：

C:\Proxy>javac *.java
C:\Proxy>java Client
no permission to update file:file01
update file:file01
C:\Proxy>

Proxy模式与Adapter模式，Decorator模式，Builder模式等的区别

Proxy模式与其他几个构造型模式比如Adapter模式，Decorator模式等很相似，
设计模式之Adapter - 适配器模式
设计模式之Bridge - 桥接模式
设计模式之Decorator - 装饰模式
与Proxy模式一样，它们具有以下相同点：
- 都是构造型的设计模式
- 都是通过新类对原有类的封装（继承或委让的方式），即通过新类访问原有的类。
但它们不同点：
- 目的或行为结果不同：
    Proxy模式在客户端访问目标对象前或后，需要进行某些特别的处理；
    Adapter模式则纯粹为了给目标类或库等作一个封装，使其适合被新的系统使用，即Adapter模式是为了给目标类统一接口；
    Bridge模式则是为了分离事务内部具有并列属性的抽象与具体行为；
    Decorator模式则是可以在运行期动态地改变一个对象方法的行为。
- 接口的方式不同：
    Proxy模式中被代理的目标对象与Proxy类使用同一个接口；
    Adapter模式是为调用原对象而准备一个新的接口；
    Bridge模式中的抽象与具体行为分别使用2个不同的接口。
    Decorator模式除了装饰（Decorator）类与被装饰的类使用同一个接口之外，装饰（Decorator）类的实现还使用委让的方式。

在实际的应用中，根据我们的目的的不同而选用不同的设计模式。