CF代码解析之(vcap-java)

Vcap-java概述

Vcap-java 是cloud foundry为了在java中更好的使用CF做的封装包。

源代码下载路径：https://https://www.360docs.net/doc/1612763875.html,/cloudfoundry/vcap-java

解压后如图：

包括auto-reconfiguration,cloudfoundry-runtime,plugins,comcat-setup等目录。

auto-reconfiguration: 主要为spring项目从本地开发移植到CF中做自动重配置，主要功能是替换数据源。

cloudfoundry-runtime：主要为spring框架添加了各种云特征的标签比如cloud:data-source。

plugins：是java应用的运行环境对tomcat的封装扩展。

当我们系统部署到CF后，CF会自动为我们引入reconfiguration和runtime两个包。

备注：如果我们的java工程未使用到spring，那么这个包基本作废。

代码解析

Cloudfoundry-runtime

解读runtime需对spring的自定义标签有一定了解，其实runtime包就是一个spring为支持CF所做的新标签包。

我们来看src下的resource目录

如上图

查看spring.schemas

http\://https://www.360docs.net/doc/1612763875.html,/spring/cloudfoundry-spring-0.8.xs d

=org/cloudfoundry/runtime/service/config/xml/cloudfoundry-spring. xsd

http\://https://www.360docs.net/doc/1612763875.html,/spring/cloudfoundry-spring.xsd

=org/cloudfoundry/runtime/service/config/xml/cloudfoundry-spring. xsd

新标签的schema文件为cloudfoundry-spring.xsd ，具体内容请看附件。

重要几个标签，如下图：

Cloud标签

data-source

data-source标签是CF上关系型数据库的数据源标签，属性包括id，name，元素包括connection，pool。

目前CF上关系型数据库包括：mysql，PostgreSQL

rabbit-connection-factory

是rabbitMQ的连接池，rabbitMQ是消息中间件。

redis-connection-factory

是redis连接池配置。redis是一个key-value存储系统。和Memcached 类似，它支持存储的value类型相对更多，包括string(字符串)、list(链表)、set(集合)和zset(有序集合)。这些数据类型都支持push/pop、add/remove 及取交集并集和差集及更丰富的操作，而且这些操作都是原子性的。在此基础上，redis支持各种不同方式的排序。与memcached一样，为了保证效率，数据都是缓存在内存中。区别的是redis会周期性的把更新的数据写入磁盘或者把修改操作写入追加的记录文件，并且在此基础上实现了master-slave(主从)同步。

mongo-db-factory

指mongoDB连接池配置。MongoDB是一个介于关系数据库和非关系数据库之间的产品，是非关系数据库当中功能最丰富，最像关系数据库的。他支持的数据结构非常松散，是类似json的bjson格式，因此可以存储比较复杂的数据类型。Mongo最大的特点是他支持的查询语言非常强大，其语法有点类似于面向对象的查询语言，几乎可以实现类似关系数据库单表查询的绝大部分功能，而且还支持对数据建立索引。

properties

读取CF上的环境变量信息，支持在配置文件中使用占位符

service-scan

与spring原先的配置类似，是一个注释扫描的标签。标签解析

完成解析工作，会用到NamespaceHandler和BeanDefinitionParser这两个概念。具体说来NamespaceHandler会根据schema和节点名找到某个BeanDefinitionParser，然后由BeanDefinitionParser完成具体的解析工作。Spring 提供了默认实现类NamespaceHandlerSupport和AbstractSingleBeanDefinitionParser，runtime就是使用了这种扩展机制。

CF 标签的实现类，在spring.handlers中配置，配置信息如下：

如上所示，CloudNamespaceHandler是具体的实现类

命名空间Handler（CloudNamespaceHandler）

org.cloudfoundry.runtime.service.keyvalue.CloudRedisConnectionFactory Bean;

import

org.cloudfoundry.runtime.service.messaging.CloudRabbitConnectionFacto ryBean;

import

org.cloudfoundry.runtime.service.relational.CloudDataSourceFactory; import

org.springframework.beans.factory.xml.AbstractSimpleBeanDefinitionPar ser;

import https://www.360docs.net/doc/1612763875.html,spaceHandlerSupport; import org.w3c.dom.Element;

/**

* Handler for the 'cloud' namespace

*

* @author Mark Fisher

* @author Costin Leau

* @author Ramnivas Laddad

* @author Scott Andrews

* @author Thomas Risberg

*

*/

publicclass CloudNamespaceHandler extends NamespaceHandlerSupport {

@Override

publicvoid init() {

this.registerBeanDefinitionParser("rabbit-connection-factory", new

CloudRabbitConnectionFactoryParser(CloudRabbitConnectionFactoryBean.c lass, RabbitServiceInfo.class));

this.registerBeanDefinitionParser("redis-connection-factory", new

CloudRedisConnectionFactoryParser(CloudRedisConnectionFactoryBean.cla ss, RedisServiceInfo.class));

this.registerBeanDefinitionParser("mongo-db-factory",

new

CloudMongoDbFactoryParser(CloudMongoDbFactoryBean.class, MongoServiceInfo.class));

this.registerBeanDefinitionParser("data-source",

new

CloudDataSourceFactoryParser(CloudDataSourceFactory.class, RdbmsServiceInfo.class));

this.registerBeanDefinitionParser("properties", new AbstractSimpleBeanDefinitionParser() {

@Override

protected Class getBeanClass(Element element) {

return CloudPropertiesFactoryBean.class;

}

});

this.registerBeanDefinitionParser("service-scan", new AbstractSimpleBeanDefinitionParser() {

@Override

protected Class getBeanClass(Element element) {

return CloudServicesScanner.class;

}

@Override

protectedboolean shouldGenerateId() {

returntrue;

}

});

}

}

我们看到在init方法中定义了各种标签的实现类（registerBeanDefinitionParser方法就是把节点名和解析类联系起来）

解析类

这些bean定义解析类之间的关系如下：

四个标签解析类都继承自AbstractCloudServiceFactoryParser，父类就是spring提供的扩展类

AbstractSingleBeanDefinitionParser。AbstractCloudServiceFactoryParser重写了createInstance，代码如下：

此方法可以看出最后返回的bean实例是service，且都是通过抽象方法：protected abstract AbstractServiceCreator getServiceCreator();

获得ServiceCreator对象，然后调用ServiceCreator.createSingletonService返回具体的Service实例。

如上表所示：各种标签的解析类都实现了抽象方法getServiceCreator，返回了具体的服务创建者。

服务实例创建者

在看AbstractServiceCreator.createSingletonService方法

最后归结到AbstractServiceCreator.createService

抽象类AbstractServiceCreator定义了各种服务创建者必须实现的方法：public abstract S createService(SI serviceInfo);

分析四个服务创建者,最后创建服务后返回的bean，如下表：

标签使用例子

请看：

https://www.360docs.net/doc/1612763875.html,/frameworks/java/spring/spring.html

首先在spring的配置文件，头中要加入cloud标签的相关内容：

xmlns:xsi="https://www.360docs.net/doc/1612763875.html,/2001/XMLSchema-instance"

xmlns:context="https://www.360docs.net/doc/1612763875.html,/schema/context" xmlns:cloud="https://www.360docs.net/doc/1612763875.html,/spring"

xsi:schemaLocation="https://www.360docs.net/doc/1612763875.html,/schema/beans https://www.360docs.net/doc/1612763875.html,/schema/beans/spring-beans-3.1.xsd https://www.360docs.net/doc/1612763875.html,/schema/context

https://www.360docs.net/doc/1612763875.html,/schema/context/spring-context-3.1.xsd https://www.360docs.net/doc/1612763875.html,/spring

https://www.360docs.net/doc/1612763875.html,/spring/cloudfoundry-spring.xsd >

可用标签如下图：

建议使用spring3.1的新特征profile，可以在本地开发，发布到CF不用修改配置文件。发布到云上后，profile="cloud"的配置会生效，如果在本地profile="cloud"不会被加载。

配置例子：

destroy-method="close">

auto-reconfiguration

自动重新配置模块主要是为本地开发与发布到云做了更多智能化的事情，但是也有条件限制

1、各种服务类型的服务实例只能有一个

2、在spring中同种服务也只能有一个配置，比如关系型数据库只能有一个

datasource的配置

3、不使用CF的标签（可以使用properties标签）

如果符合这两个条件，auto-reconfiguration会自动将您本地的数据库配置修改为cloud为您的应用提供的数据库服务配置。

也就是说如果你的应用只用到一个数据库用户，那你直接在本地用spring开发，通过datasource来获得连接，那么你直接发布到CF上，可以直接运行（您的应用必须先绑定一个同类数据库的service）。

原理

当你发布Spring应用到CF，CF会将系统的各种参数（包括应用的参数、服务的参数等）设置到环境变量中，并会自动修改您应用中的web.xml

（

修改web.xm的过程请看CF源代码包:

staging/lib/vcap/staging/plugin/java_web

staging/lib/vcap/staging/plugin/spring

目录），

主要包括以下两个修改：

加入CloudApplicationContextInitializer

Cf自动在web.xml加入：

备注：contextInitializerClasses配置项，必须在web.xml有配置listener才可生效

可以使用：org.springframework.web.context.ContextLoaderListener

CloudApplicationContextInitializer代码如下：

@Override

publicfinalvoid initialize(ConfigurableApplicationContext applicationContext) {

if (!cloudFoundryEnvironment.isCloudFoundry()) {

https://www.360docs.net/doc/1612763875.html,("Not running on Cloud Foundry, skipping initialization");

return;

}

try {

https://www.360docs.net/doc/1612763875.html,("Initializing Spring Environment for Cloud Foundry");

springEnvironment = applicationContext.getEnvironment();

addPropertySource(buildPropertySource());

addActiveProfile("cloud");

} catch (Throwable t) {

logger.error("Unexpected exception on initialization: " +

t.getMessage(), t);

}

}

在spring中ApplicationContextInitializer的initialize方法在加载配置文件前会被调用。

如initialize代码所示，CloudApplicationContextInitializer首先判断运行环境是否是云环境，如果是云环境，自动从环境变量VCAP_APPLICATION获得app信息，从VCAP_SERVICES获得services信息，都加载到参数中，并设置cloud标签为active 等。

加入bean配置文件

Cf会在web.xml的contextConfigLocation的值中加入：

这样spring在初始化是会加载:

META-INF/cloud/cloudfoundry-auto-reconfiguration-context.xml中配置的类。

cloudfoundry-auto-reconfiguration-context.xml文件如下：

xmlns:xsi="https://www.360docs.net/doc/1612763875.html,/2001/XMLSchema-instance"

xmlns:util="https://www.360docs.net/doc/1612763875.html,/schema/util"

xsi:schemaLocation="https://www.360docs.net/doc/1612763875.html,/schema/beans

https://www.360docs.net/doc/1612763875.html,/schema/beans/spring-beans-2.5.xsd

https://www.360docs.net/doc/1612763875.html,/schema/util

https://www.360docs.net/doc/1612763875.html,/schema/util/spring-util-2.5.xsd">

Replacement bean definitions for cloud

deployment

org.hibernate.dialect.PostgreSQLDialect

org.hibernate.dialect.MySQLDialect

org.hibernate.dialect.PostgreSQLDialect

org.hibernate.dialect.MySQLDialect

如上，在cloudfoundry-auto-reconfiguration-context.xml中，CF预先定义了一个类：

CloudAutoStagingBeanFactoryPostProcessor

而CloudAutoStagingBeanFactoryPostProcessor继承了BeanFactoryPostProcessor接

口

并实现了postProcessBeanFactory方法，代码如下：

备注：BeanFactoryPostProcessor的类在spring实例化类前会调用方法postProcessBeanFactory

publicvoid postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {

if (autoStagingOff(CLOUD_SERVICES_FILE,beanFactory)) {

return;

}

DefaultListableBeanFactory defaultListableBeanFactory = (DefaultListableBeanFactory) beanFactory;

// defaultListableBeanFactory.getBean(CloudEnvironment.class) will do,

// but we go through a mechanism that will work for spring-2.5.x as well

Map cloudEnvironmentBeans =

defaultListableBeanFactory.getBeansOfType(CloudEnvironment.class,true,false);

CloudEnvironment cloudEnvironment;

if (cloudEnvironmentBeans.size() > 1) {

logger.log(https://www.360docs.net/doc/1612763875.html,, "Multiple (" + cloudEnvironmentBeans.size()

+ ") CloudEnvironmentBeans found; zero or 1 expected");

return;

} elseif (cloudEnvironmentBeans.size() == 1) {

cloudEnvironment =

cloudEnvironmentBeans.entrySet().iterator().next().getValue();

} else {

cloudEnvironment = new CloudEnvironment();

}

New DataSourceConfigurer(cloudEnvironment).configure(defaultListableBeanFactory);

new MongoConfigurer(cloudEnvironment).configure(defaultListableBeanFactory);

new RedisConfigurer(cloudEnvironment).configure(defaultListableBeanFactory);

new RabbitConfigurer(cloudEnvironment).configure(defaultListableBeanFactory);

}

1、判断spring中是否已经包括CloudServicesScanner或者AbstractCloudServiceFactory的定义，如果包含则直接退出，如果不包含则进行重新配置的具体操作。代码如下：

if (autoStagingOff(CLOUD_SERVICES_FILE,beanFactory)) {

return;

}

boolean autoStagingOff(String cloudServiceFileLocations, ConfigurableListableBeanFactory beanFactory) {

Resource[] resources;

try {

resources =

applicationContext.getResources(cloudServiceFileLocations);

} catch (IOException e) {

logger.log(Level.WARNING, "Error scanning for cloud services files: " + cloudServiceFileLocations

+ ". Autostaging will be active.", e);

returnfalse;

}

for (Resource resource : resources) {

BufferedReader fileReader = null;

try {

fileReader = new BufferedReader(new

InputStreamReader(resource.getInputStream()));

for (String line = fileReader.readLine(); line != null; line = fileReader.readLine()) {

String cloudServiceClassName = line.trim();

if (usingCloudService(beanFactory, cloudServiceClassName)) {

returntrue;

}

}

} catch (IOException e) {

logger.log(Level.WARNING, "Error reading cloud service file: " + resource

+ ". File contents will not be evaluated for cloud services.", e);

} finally {

if (fileReader != null) {

try {

fileReader.close();

} catch (IOException e) {

logger.log(Level.WARNING, "Error closing file: "+ fileReader, e);

}

}

}

}

logger.log(https://www.360docs.net/doc/1612763875.html,, "Autostaging is active.");

returnfalse;

}

privateboolean usingCloudService(ConfigurableListableBeanFactory beanFactory, String cloudServiceClassName) {

Class cloudServiceFactoryClazz =

loadClass(cloudServiceClassName);

if(cloudServiceFactoryClazz == null ||

beanFactory.getBeanNamesForType(cloudServiceFactoryClazz,true,false). length == 0) {

returnfalse;

}

logger.log(https://www.360docs.net/doc/1612763875.html,,"Found an instance of " + cloudServiceClassName + ". Autostaging will be skipped.");

returntrue;

}

为什么这么判断呢？在我们前面讲到cloud的标签的解析类中的四种数据源标签返回的bean类型都是AbstractCloudServiceFactory的实现类，而CloudServicesScanner 是标签cloud:service-scan的bean类型，唯独properties返回的bean类型是CloudPropertiesFactoryBean，那意味着如果我们已经使用了cloud:service-scan和另外四种数据源的标签则退出，不进行自动配置。

如果未配置，执行下面代码:

如上代码所示，CF会重新配置这四种数据源。

我们看四种Configurer类的关系，如下：

显然他们有相同的父类AbstractServiceConfigurer

那么configuer方法做了什么呢？看下面代码：

publicboolean configure(DefaultListableBeanFactory beanFactory) { //获得工厂中包括此类型的对象数量（类型由子类提供，是个抽象方法）

String[] beanNames = getBeanNames(beanFactory);

if (beanNames.length == 0) {

logger.log(https://www.360docs.net/doc/1612763875.html,, "No beans of type " + getBeanClass() + " found in application context");

returnfalse;

} elseif (beanNames.length> 1) {

logger.log(https://www.360docs.net/doc/1612763875.html,, "More than 1 (" + beanNames.length + ") beans of type " + getBeanClass()

+ "found in application context. Skipping autostaging.");

returnfalse;

}

List cloudServices =

cloudEnvironment.getServiceInfos(serviceInfoClass);

if (cloudServices.isEmpty()) {

logger.log(https://www.360docs.net/doc/1612763875.html,, "No services found. Skipping autostaging");

returnfalse;

}

if (cloudServices.size() > 1) {

logger.log(https://www.360docs.net/doc/1612763875.html,, "Error creating cloud service.