CloudStack核心类ApiServlet、ApiServer、ApiDispatcher、GenericDaoBase源码分析

ApiServlet

首先从整体上看下ApiServlet，Outline视图如下，

一、注意@Inject依赖的是javax.inject.jar，它和spring的@Autowired的区别在于使用它时变量不用生成相应的set方法。

二、CloudStack所有的请求都会被ApiSerlet拦截处理，进入到doGet()或者doPost()方法，然后统一交由processRequest()处理。

三、processRequestInContext()方法：

1、更多的是日志记录和异常信息处理（auditTrailSb变量）；

2、utf8Fixup(req,params)对请求参数进行统一的UTF-8解码；

3、对Session的处理(isNew)和命令权限的审核（verifyRequest（params,userId））；

4、如果不是登录（log）和注销（logout）操作，则会转由ApiServer的handleRequest()方法处理。

四：***Response()方法生成响应。

ApiServer

一、ApiServer继承自ManageBase，实现了HttpRequestHandler和ApiServerService接口。

二、ApiServer重点是queueCommand(BaseCmd cmdObj,Map<String,String> params)方法，该方法决定命令被序列化还是被分派。

如何处理命令取决于cmd的超类，如果超类是：

BaseCmd：cmd会被调配到ApiDispatcher执行、序列化和返回。

BaseAsyncCreatedCmd：cmd参数会被处理然后调用其create()方法，然后和BaseAsyncCmd流程一样。

BaseAsyncCmd：cmd会被处理并当做异步任务(AsyncJob)提交，job相关的信息是序列化的，然后返回。

三、verifyRequest()方法里调用checkCommandAvailable(User user,Strnig commandName)检查命令对该用户是否可用，这里自动注入List<APIChecker>  _apiAccessCheckers，在spring-server-core-misc-context.xml里我们可以看到<property name=“apiAccessCheckers” value=”#{apiCheckersRegistry.registered}”/>。

四、继承自HttpRequestHandler的handle()方法只处理来自8096端口的OTW请求。

ApiDispatcher

一、Q:CloudStack前端传到后台的参数在后台是如何处理并使用的？
     A:1、参数最终是被封装到请求对应的Cmd对象中再供其他地方使用的。
        2、在ApiDispatcher类dispatch方法会调用processParameters(BaseCmd cmd,Map<String,String> params)方法，processParameters(BaseCmd cmd,Map<String,String> params)方法中通过List<Field> fields = ReflectUtil.getAllFieldsForClass(cmd.getClass(),BaseCmd.class)得到预先定义在Cmd中的参数字段。然后遍历fields，通过setFieldValue(field,cmd,paramObj,parameterAnnotation)利用Java的反射机制解析到对应的Cmd对象中。

通过修改Cmd中的参数字段，就可以操控在数据库里添加的字段。

二、处理完参数后cmd.execute()执行命令。

GenericDaoBase

一、cglib proxy的使用

protected Class<T> _entityBeanType;
...
protected Enhancer _enhancer;
protected Factory _factory;
...
protected final static CallbackFilter s_callbackFilter = new UpdateFilter();
...
Callback[] callbacks = new Callback[] { NoOp.INSTANCE, new UpdateBuilder(this) };

_enhancer = new Enhancer();
_enhancer.setSuperclass(_entityBeanType);
_enhancer.setCallbackFilter(s_callbackFilter);
_enhancer.setCallbacks(callbacks);
_factory = (Factory)_enhancer.create();

这里UpdateFilter类实现cglib里的CallbackFilter接口

public class UpdateFilter implements CallbackFilter {
    @Override
    public int accept(Method method) {
        String name = method.getName();
        return (name.startsWith("set") || name.startsWith("incr") || name.startsWith("decr")) ? 1 : 0;
    }
}

当method以set/incr/decr开始时，返回1，否则返回0。返回1时就使用cglib自带的空拦截器NoOp.INSTANCE，返回0即update操作时就会调用UpdateBuilder拦截器。

UpdateBuilder实现了MethodInterceptor接口的intercept方法：

public class UpdateBuilder implements MethodInterceptor {
    protected Map<String, Ternary<Attribute, Boolean, Object>> _changes;
    protected HashMap<Attribute, Object> _collectionChanges;
    protected GenericDaoBase<?, ?> _dao;

    protected UpdateBuilder(GenericDaoBase<?, ?> dao) {
        _dao = dao;
        _changes = new HashMap<String, Ternary<Attribute, Boolean, Object>>();
    }

    @Override
    public Object intercept(Object object, Method method, Object[] args, MethodProxy methodProxy) throws Throwable {
        String name = method.getName();
        if (name.startsWith("set")) {
            String field = methodToField(name, 3);
            makeChange(field, args[0]);
        } else if (name.startsWith("incr")) {
            makeIncrChange(name, args);
        } else if (name.startsWith("decr")) {
            makeDecrChange(name, args);
        }
        return methodProxy.invokeSuper(object, args);
    }
   ...
}

关于cglib这部分的应用可参考这篇博文http://www.blogjava.net/stone2083/archive/2008/03/16/186615.html。

二：数据库操作JDBC的使用

主要看searchIncludingRemoved()方法里的关键代码：

public List<T> searchIncludingRemoved(SearchCriteria<T> sc, final Filter filter, final Boolean lock,
            final boolean cache, final boolean enable_query_cache) {
        String clause = sc != null ? sc.getWhereClause() : null;
        ...final StringBuilder str = createPartialSelectSql(sc, clause != null, enable_query_cache);
        ...
                addJoins(str, joins);
        ...
        List<Object> groupByValues = addGroupBy(str, sc);
        addFilter(str, filter);

        final TransactionLegacy txn = TransactionLegacy.currentTxn();
        ...
        final String sql = str.toString();
        PreparedStatement pstmt = null;
        final List<T> result = new ArrayList<T>();
        try {
            pstmt = txn.prepareAutoCloseStatement(sql);
            ...final ResultSet rs = pstmt.executeQuery();
            while (rs.next()) {
                result.add(toEntityBean(rs, cache));
            }
            return result;
      ...
    }

在这里我们可以看到最终执行的sql，以及它是如何拼接出来的。