原文:
深入浅出CGlib-打造无入侵的类代理
CGlib是一个强大的,高性能,高质量的Code生成类库(Code Generate library)。
它可以在运行期扩展Java类与实现Java接口。
当然这些实际的功能是asm所提供的,asm又是什么?
Java字节码操控框架,具体是什么大家可以上网查一查,毕竟我们这里所要讨论的是cglib,
cglib就是封装了asm,简化了asm的操作,实现了在运行期动态生成新的class。我们模拟一个虚拟的场景,模拟对表的操作。
1. 开始我们对表提供了CRUD方法。
我们现在创建一个对Table操作的DAO类。
public class TableDAO { public void create(){ System.out.println("create() is running !"); } public void query(){ System.out.println("query() is running !"); } public void update(){ System.out.println("update() is running !"); } public void delete(){ System.out.println("delete() is running !"); } }
OK,它就是一个javaBean,提供了CRUD方法的javaBean。
下面我们创建一个DAO工厂,用来生成DAO实例。
public class TableDAOFactory { private static TableDAO tDao = new TableDAO(); public static TableDAO getInstance(){ return tDao; } }
接下来我们创建客户端,用来调用CRUD方法。
public class Client { public static void main(String[] args) { TableDAO tableDao = TableDAOFactory.getInstance(); doMethod(tableDao); } public static void doMethod(TableDAO dao){ dao.create(); dao.query(); dao.update(); dao.delete(); } }
OK,完成了,CRUD方法完全被调用了。当然这里并没有CGlib的任何内容。问题不会这么简单的就结束,新的需求来临了。
2. 变化随之而来,Boss告诉我们这些方法不能开放给用户,只有“张三”才有权使用。
阿~!怎么办,难道我们要在每个方法上面进行判断吗?
好像这么做也太那啥了吧,对了对了Proxy可能是最好的解决办法。jdk的代理就可以解决了。
好了我们来动手改造吧。等等jdk的代理需要实现接口,这样, 我们的dao类需要改变了。
既然不想改动dao又要使用代理,我们这就请出CGlib。
我们只需新增一个权限验证的方法拦截器
public class AuthProxy implements MethodInterceptor { private String name ; //传入用户名称 public AuthProxy(String name){ this.name = name; } public Object intercept(Object arg0, Method arg1, Object[] arg2, MethodProxy arg3) throws Throwable { //用户进行判断 if(!"张三".equals(name)){ System.out.println("你没有权限!"); return null; } return arg3.invokeSuper(arg0, arg2); } }
当然不能忘了对我们的dao工厂进行修改,我们提供一个使用代理的实例生成方法
public static TableDAO getAuthInstance(AuthProxy authProxy){ Enhancer en = new Enhancer(); //进行代理 en.setSuperclass(TableDAO.class); en.setCallback(authProxy); //生成代理实例 return (TableDAO)en.create(); }
我们这就可以看看客户端的实现了。添加了两个方法用来验证不同用户的权限。
public static void haveAuth(){ TableDAO tDao = TableDAOFactory.getAuthInstance(new AuthProxy("张三")); doMethod(tDao); } public static void haveNoAuth(){ TableDAO tDao = TableDAOFactory.getAuthInstance(new AuthProxy("李四")); doMethod(tDao); }
哈哈,现在可难不倒我们了,因为我们使用了CGlib。
当然最简单的方式是去修改我们的方法拦截器,不过这样会使逻辑变得复杂,且 不利于维护。
还好CGlib给我们提供了方法过滤器(CallbackFilter),
CallbackFilte可以明确表明,被代理的类中不同的方法, 被哪个拦截器所拦截。
下面我们就来做个过滤器用来过滤query方法。
public class AuthProxyFilter implements CallbackFilter{ public int accept(Method arg0) { if(!"query".equalsIgnoreCase(arg0.getName())) return 0; // 返回第0个filter, 空的拦截器,即不过滤 return 1; // 返回第1个filter, 我们自定义的拦截器 } }
OK,可能大家会对return 0 or 1感到困惑,用到的时候就会讲解,当然下面就会用到了。
我们在工场中新增一个使用了过滤器的实例生成方法。
我们在工场中新增一个使用了过滤器的实例生成方法
public static TableDAO getAuthInstanceByFilter(AuthProxy authProxy){
Enhancer en = new Enhancer();
en.setSuperclass(TableDAO.class);
en.setCallbacks(new Callback[]{authProxy,NoOp.INSTANCE}); // 顺序为 0
en.setCallbackFilter(new AuthProxyFilter()); // 顺序为 1
return (TableDAO)en.create();
}
一定要和CallbackFilter里面的顺序一致。明白了吗?上面return返回的就是返回的顺序。
也就是说如果调用query方法就使用NoOp.INSTANCE进行拦截。
现在看一下客户端代码。
public static void haveAuthByFilter(){ TableDAO tDao = TableDAOFactory.getAuthInstanceByFilter(new AuthProxy("张三")); doMethod(tDao); tDao = TableDAOFactory.getAuthInstanceByFilter(new AuthProxy("李四")); doMethod(tDao); }
ok,现在"李四"也可以使用query方法了,其他方法仍然没有权限。
哈哈,当然这个代理的实现没有任何侵入性,无需强制让dao去实现接口。