JSF配置

                                                                                                      

• 使用说明   
• 元素及其属性
  •    
  • <jsf:registry>    
  • <jsf:server>   
  • <jsf:provider>   
  • <jsf:consumer>   
  • <jsf:method>   
  • <jsf:parameter>   
  • <jsf:annotation>   
  • <jsf:filter>   
  • <jsf:consumerGroup>   
  • <jsf:connStrategy>

使用说明

使用是在spring的头上加上jsf.xsd。参考如下：

<? xml version = "1.0" encoding = "UTF-8" ?> < beans xmlns = "http://www.springframework.org/schema/beans"      xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance" xmlns:jsf = "http://jsf.jd.com/schema/jsf"      xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd      http://jsf.jd.com/schema/jsf  http://jsf.jd.com/schema/jsf/jsf.xsd"> </ beans >

元素及其属性

<jsf:registry> 

一级元素，下面可以有parameter节点。对应com.jd.jsf.gd.config.RegistryConfig

配置注册中心用，注册服务和订阅服务，订阅配置。 全局唯一即可。

标签	属性	类型	是否必填	默认值	描述	起始版本
registry	address	string	是1		注册中心地址，多个用逗号分隔	1.0.0
registry	index	string	是1		注册中心Index服务地址	1.0.0
registry	id	string	是		Spring的BeanId	1.0.0
registry	protocol	string	否	jsfRegistry	注册中心协议	1.0.0
registry	timeout	int	否	20000（v1.0） 5000	v1.0连接注册中心的超时时间，单位毫秒 v1.2改为调用注册中心超时时间，单位毫秒	1.0.0
registry	connectTimeout	int	否	20000	连接注册中心的超时时间，单位毫秒	1.2.0
registry	file	string	否	${user.home}/jsf	备份文件保存地址	1.0.0
registry	register	boolean	否	true	是否注册服务	1.0.0
registry	subscribe	boolean	否	true	是否订阅服务列表	1.0.0
registry	batchCheck	int	否	10	定时批量检查时的条目数	1.2.0

注1：address和index 必须存在一个。

<jsf:server>

一级元素，下面可以有parameter节点。对应com.jd.jsf.gd.config.ServerConfig

配置服务端用，只在发布服务端时候声明。一个server对应一个端口一个协议。一个server下可以发布多个provider。

 

标签	属性	类型	是否必填	默认值	描述	起始版本
server	id	string	是		Spring的BeanId	1.0.0
server	protocol	string	是		服务端协议。	1.0.0
server	host	string	否		服务端绑定地址（windows默认绑到某个ip，linux默认绑到0.0.0.0）。 未指定时，如果配置了注册中心则会连注册中心获取地址，未配注册中心则从网卡里取一个	1.0.0
server	port	int	否	22000	服务端绑定端口。 如果已被绑定则自动+1重试，配置为"-1"表示随机端口，不过也是从22000开始随机。	1.0.0
server	contextpath	string	否	/	发布上下文。用于基于http的协议。	1.0.0
server	threads	int	否	200	最大业务线程池大小	1.0.0
server	iothreads	int	否	0	IO线程池大小，程序中默认max(8,cpu+1)	1.0.0
server	threadpool	string	否	cached	业务线程池类型，参见JSF用户手册#线程池类型	1.0.0
server	telnet	boolean	否	true	是否允许telnet	1.0.0
server	queues	int	否	0	业务线程池队列大小。0表示无队列，-1表示无限队列，正整数表示有限队列	1.0.0
server	accepts	int	否	2147483647	允许的TCP长连接数（包括http）	1.0.0
server	payload	int	否	8388608	允许的数据包大小	1.0.0
server	buffer	int	否	8192	IO的缓冲区大小
server	serialization	string	否	msgpack	序列化方式。 建议不配置、服务端会根据客户端序列化方式自适应。	1.0.0
server	dispatcher	string	否	message	事件分发类型，目前无其它选项。参考JSF用户手册#事件分发类型	1.0.0
server	virtualhost	string	否		虚拟IP地址（注册到注册中心的地址，可以和绑定地址不一样） 多用于虚拟机环境，例如绑定地址为172.17.1.1，告诉注册中心为192.168.1.1	1.0.0
server	virtualhostfile	string	否		虚拟IP地址文件，同上，只是从文件中读取。	1.0.0
server	onconnect	ref	否		连接事件监听器实例，多个用逗号分隔。List<ConnectListener>	1.0.0
server	debug	boolean	否	false	是否打印请求和响应消息体信息	1.0.0
server	epoll	boolean	否	false	Linux下是否启动epoll特性	1.0.0
server	queuetype	string	否	normal	业务线程池队列类型。普通队列normal、优先级队列priority	1.0.0
server	daemon	boolean	否	true	默认为守护线程，主线程退出自动退出。配置为false则需要主动退出。	1.0.0
server	acceptSerializations	string	否	msgpack,hessian,json,protobuf	支持的序列化方式，配置时用英文 "," 隔开。List<String> 1.6.5开始默认不支持java序列化，如有需求需要自行配置 例：msgpack,hessian,json,protobuf,java	1.6.5

<jsf:provider>

一级元素，下面可以有method或者parameter节点。对应com.jd.jsf.gd.config.ProviderConfig

发布jsf服务Provider使用。

 

标签	属性	类 型	是否必填	默认值	描述	起始版本
provider	registry	ref	是2	全部registry	注册中心引用，多个用英文逗号隔开。List<RegistryConfig>	1.0.0
provider	server	ref	是1	全部server	需要发布服务到的Server，对应上面jsf:server的id，多个用英文逗号隔开。 一个server对应一个端口一个协议，List<ServerConfig>	1.0.0
provider	id	string	是		Spring的BeanId	1.0.0
provider	interface	string	是		发布的接口名称	1.0.0
provider	alias	string	是		服务别名分组信息	1.0.0
provider	ref	ref	是		接口实现类	1.0.0
provider	filter	ref	否		过滤器实现链，多个用英文逗号隔开。 List<AbstractFilter>	1.0.0
provider	register	boolean	否	true	是否注册到注册中心	1.0.0
provider	subscribe	boolean	否	true	是否从注册中心订阅	1.0.0
provider	timeout	int	否	5000	服务端调用超时时间，单位毫秒。只是打印警告，不会打断代码执行	1.2.0
provider	proxy	string	否	javassist	代理类生成方式，支持javassist和jdk	1.0.0
provider	mockref	ref	否		Mock调用实现，配合mock属性实现开启关闭。mockref是interface的本地实现，用于服务降级	1.0.0
provider	cacheref	ref	否		结果缓存实现，配合cache属性实现开启关闭。cacheref实现com.jd.jsf.filter.cache.Cache	1.0.0
provider	delay	int	否	0	延迟发布服务时间。 例如：配置0表示加载时即时发布，-1表示spring加载完毕后发布，5000表示延迟5秒后发布	1.0.0
provider	weight	int	否	100	服务提供者权重	1.0.0
provider	include	string	否	*	发布的方法列表，逗号分隔	1.0.0
provider	exclude	string	否		不发布的方法列表，逗号分隔	1.0.0
provider	dynamic	boolean	否	true	是否动态注册Provider，默认为true，配置为false代表不主动发布，需要到管理端进行上线操作	1.0.0
provider	priority	int	否	0	接口优先级，越大优先级越高，默认0
provider	concurrents	int	否	200(1.0.x-1.5.x) 0(1.6.0+)	接口下每方法的最大可并行执行请求数，配置-1关闭并发过滤器，等于0表示开启过滤但是不限制	1.0.0
provider	validation	boolean	否	false	是否校验参数，支持JSR303 JSF用户手册#参数校验	1.0.0
provider	compress	string	否		压缩算法（启动后是否压缩还取决于数据包大小），支持lzma/snappy	1.0.0
provider	mock	boolean	否		是否启动Mock实现	1.0.0
provider	cache	boolean	否	false	是否开启结果缓存。如果开启需要指定cachekref	1.0.0

1. 集成Spring时，如果未指定，则默认发全部服务端
2. 集成Spring时，如果未指定，则默认发全部注册中心。

<jsf:consumer>

作为一级元素，下面可以有method或者parameter节点。对应com.jd.jsf.gd.config.ConsumerConfig

作为二级元素，ConsumerGroup下的元素。

发布jsf服务Consumer使用。

标签	属性	类 型	是否必填	默认值	描述	起始版本
consumer	id	string	是		Spring的BeanId	1.0.0
consumer	interface	string	是		调用的接口名称。	1.0.0
consumer	alias	string	是		服务别名分组信息	1.0.0
consumer	protocol	string	是	jsf	调用的协议	1.0.0
consumer	url	string	否		直连地址，配置了此地址就不再从注册中心获取。参见：JSF客户端用户手册#直连调用	1.0.0
consumer	filter	ref	否		过滤器实现链，多个用英文逗号隔开。 List<AbstractFilter>	1.0.0
consumer	registry	ref	是1	全部registry	注册中心引用，多个用英文逗号隔开。List<RegistryConfig>	1.0.0
consumer	register	boolean	否	true	是否注册到注册中心	1.0.0
consumer	subscribe	boolean	否	true	是否从注册中心订阅	1.0.0
consumer	timeout	int	否	5000	调用端调用超时时间，单位毫秒。超过时间客户端抛超时异常。	1.0.0
consumer	proxy	string	否	javassist	代理类生成方式，支持javassist和jdk	1.0.0
consumer	mockref	ref	否		Mock调用实现，配合mock属性实现开启关闭。mockref是interface的本地实现，用于服务降级	1.0.0
consumer	cacheref	ref	否		结果缓存实现，配合cache属性实现开启关闭。cacheref实现com.jd.jsf.filter.cache.Cache接口	1.0.0
consumer	generic	boolean	否	false	是否泛化调用（无需服务端接口类）	1.0.0
consumer	async	boolean	否	false	是否异步调用，参见JSF用户手册#异步调用	1.0.0
consumer	connectTimeout	int	否	5000	建立连接超时时间，单位毫秒	1.0.0
consumer	disconnectTimeout	int	否	10000	断开连接（等待结果）超时时间，单位毫秒	1.0.0
consumer	cluster	string	否	failover	集群策略，参见JSF用户手册#集群策略	1.0.0
consumer	retries	int	否	0（0表示失败后不重试）	失败后重试次数（如果是失败策略是重试）	1.0.0
consumer	loadbalance	string	否	random	负载均衡算法，参见JSF用户手册#负载均衡	1.0.0
consumer	lazy	boolean	否	false	是否延迟建立长连接（第一次调用建立）	1.0.0
consumer	sticky	boolean	否	false	是否粘滞连接（除非断开连接，只调一个）	1.0.0
consumer	injvm	boolean	否	true	是否走injvm调用（如果同一jvm内发布了服务，则不走远程调用）。	1.0.0
consumer	check	boolean	否	false	是否强依赖服务端（无可用服务端启动失败）。	1.0.0
consumer	serialization	string	否	msgpack	序列化方式。如果是dubbo指定为hessian	1.0.0
consumer	onreturn	ref	否		方法的返回事件监听器实例，多个用逗号分隔。需要async为true时使用。List<ResponseListener>	1.0.0
consumer	onconnect	ref	否		连接事件监听器实例，连接或者断开时触发。List<ConnectListener>	1.2.0
consumer	onavailable	ref	否		客户端状态变化监听器实例，状态可用和不可以时触发。List<ConsumerStateListener>	1.2.0
consumer	threadpool	string	否	cached	业务线程池类型
consumer	threads	int	否	20	业务线程池大小
consumer	iothreads	int	否	0	IO线程池大小，程序中默认max(6,cpu+1)	1.0.0
consumer	heartbeat	int	否	60000(1.0.x) 30000(1.2.0+)	客户端往服务端发心跳包间隔，单位毫秒。配置小于0代表不发送，最低5000ms	1.0.0
consumer	reconnect	int	否	5000(1.0.x) 10000(1.2.0+)	客户端重连死亡服务端的间隔，单位毫秒。配置小于0代表不重连，最低2000ms	1.0.0
consumer	payload	int	否	8388608	允许数据包大小	1.0.0
consumer	epoll	boolean	否	false	Linux下是否启动epoll 1.0.3删除配置，客户端采用全局配置	1.0.0
consumer	router	ref	否		路由规则引用，多个用英文逗号隔开。List<Router>	1.0.0
consumer	concurrents	int	否	0	接口下每方法的最大可并行执行请求数，配置-1关闭并发过滤器，等于0表示开启过滤但是不限制	1.0.0
consumer	validation	boolean	否	false	是否校验参数，支持JSR303，参见JSF用户手册#参数校验	1.0.0
consumer	compress	string	否		压缩算法（启动后是否压缩还取决于数据包大小），支持lzma/snappy	1.0.0
consumer	mock	boolean	否	false	是否启动Mock实现	1.0.0
consumer	cache	boolean	否	false	是否开启结果缓存。如果开启需要指定cachekref	1.0.0
consumer	maxConnectThreads	int	否	10	客户端与所有服务端批量建立连接的最大线程数	1.6.1
consumer	connStrategy	ref	否		客户端连接治理策略BeanId	1.6.6-SNAPSHOT

1. 集成Spring时，如果未指定，则默认全部注册中心。

<jsf:method>

二级元素：可以出现在provider、consumer标签下，下面可以有parameter节点。对应com.jd.jsf.gd.config.MethodConfig

用于配置方法级的一些属性，覆盖接口级的属性（未配置方法则取接口级的属性）。

标签	属性	类型	是否必填	默认值	父标签	描述	起始版本
method	name	string	是		provider/consumer	方法名称（不支持重载方法）	1.0.0
method	timeout	string	否		consumer	方法调用超时时间，单位毫秒	1.0.0
method	retries	int	否		consumer	方法重试次数（0表示失败后不重试）	1.0.0
method	async	string	否		consumer	是否异步调用	1.0.0
method	validation	boolean	否		provider/consumer	是否校验参数，支持JSR303，参见JSF用户手册#参数校验	1.0.0
method	onreturn	ref	否		consumer	方法的返回事件监听器实例，多个用逗号分隔。需要async为true时使用。List<ResponseListener>	1.0.0
method	concurrents	int	否		provider/consumer	该方法的最大可并行执行请求数	1.0.0
method	mock	boolean	否		provider/consumer	是否启动Mock实现	1.0.0
method	cache	boolean	否		provider/consumer	是否开启结果缓存。如果开启需要指定cacheref	1.0.0
method	compress	string	否		provider/consumer	压缩算法（启动后是否压缩还取决于数据包大小）	1.0.0
method	dstParam	int	否		consumer	目标参数（机房/分组等）索引，从0开始计数	1.6.0

例如：

<? xml version = "1.0" encoding = "UTF-8" ?> < beans xmlns = "http://www.springframework.org/schema/beans"         xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance"         xmlns:jsf = "http://jsf.jd.com/schema/jsf"         xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd      http://jsf.jd.com/schema/jsf  http://jsf.jd.com/schema/jsf/jsf.xsd">        < jsf:consumer id = "helloServiceExport1" server = "saf" interface = "com.jd.jsf.test.HelloService" alias = "ZG1" >          < jsf:method name = "echo" retries = "2" timeout = "2222" onreturn = "" mock = "" actives = "" async = "" cache = "" compress = "" dstParam = "" />      </ jsf:consumer > </ beans >

<jsf:parameter>

作为一级元素：直接出现在spring的beans标签下。
作为二级元素：可以出现在registry、server、provider、consumer任一标签下。
或者三级元素，还可以出现在method下。
是一个key-value形式map。

标签	属性	类型	是否必填	默认值	描述	起始版本
parameter	key	string	是		参数配置关键字	1.0.0
parameter	value	string	是		参数配置值	1.0.0
parameter	hide	boolean	否	false	是否为隐藏配置。是的话，key自动加上"."作为前缀，且业务代码不能获取到，只能从filter里取到	1.0.0

例如：

<? xml version = "1.0" encoding = "UTF-8" ?> < beans xmlns = "http://www.springframework.org/schema/beans"         xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance"         xmlns:jsf = "http://jsf.jd.com/schema/jsf"         xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd      http://jsf.jd.com/schema/jsf  http://jsf.jd.com/schema/jsf/jsf.xsd">            < jsf:parameter key = "callback.pool.queue" value = "5120" /> <!--全局参数 -->        < jsf:registry id = "jsfRegistry" protocol = "jsfRegistry" index = "index.saf.jd.com" >          < jsf:parameter key = "app" value = "testsafapp" />      </ jsf:registry >        < jsf:provider id = "helloServiceExport1" server = "saf"                    interface = "com.jd.jsf.test.HelloService" alias = "ZG1" >          < jsf:parameter key = "token" value = "1q2w3e4r" hide = "true" />  <!--接口级参数 -->          < jsf:method name = "echo" retries = "2" timeout = "2222" sent = "" mock = "" actives = "" async = "" cache = "" connections = "" executes = "" >              < jsf:parameter key = "bbb" value = "bbbbbbb" /> <!--方法级参数 -->          </ jsf:method >      </ jsf:provider > </ beans >

已知的内置key (默认hide=false)

父标签	key	hidden	名称	值	备注	起始版本
registry	app	false	项目名	string	index服务匹配规则用	1.0.0
registry	lan	false	语言	string	index服务匹配规则用	1.0.0
registry	ip	false	请求ip	ip地址	index服务匹配规则用	1.0.0
server	http.keepAlive	false	JSF协议是否开启http的keepAlive特性	string	默认false	1.6.0
provider	monitor	true	是否开启监控	boolean	配置为false，不开启监控	1.0.0
provider	token	true	token	string	调用校验用	1.0.0
provider	customImpl	true	jsr303自定义实现类名	string	类名，实例化Validator用	1.0.0
consumer	monitor	true	是否开启监控	boolean	若配置为false，不开启监控	1.0.0
consumer	warnning	true	是否开启重复订阅警告	boolean	若配置为false，不检查重复发布数目	1.0.0
consumer	destroy	true	是否主动销毁	boolean	若配置为false，进程结束时不主动销毁，需手动销毁或者忽略。	1.0.0
consumer	token	true	token	string	调用校验用	1.0.0
consumer	customImpl	true	jsr303自定义实现类名	string	类名，实例化Validator用	1.0.0
beans	callback.pool.coresize	false	callback的线程池初始大小	int	默认20	1.0.0
beans	callback.pool.maxsize	false	callback的线程池最大大小	int	默认200	1.0.0
beans	callback.pool.queue	false	callback的线程池队列	int	默认256	1.0.0
beans	serialize.check.class	false	序列化时是否检查父子类（声明参数和传入值是父子类）	boolean	默认true，如果业务不存在这种情况可以配置为false，提高性能	1.0.0
beans	transport.consumer.epoll	false	客户端是否使用epoll（针对linux）	boolean	默认false，Linux开启epoll可提高性能	1.0.3
beans	counter.batch	false	计数器服务调用步长	int	默认1，每次丢调用计数器，调大可以提高性能但会减低精准	1.2.0
beans	json.serialize.fill.empty	false	json序列化是否返回null字段。	boolean	默认false，默认只返回有属性的字段。打开会降低效率。	1.5.1
beans	consumer.provider.nullable	false	consumer的服务端列表是否可被清空	boolean	默认false，默认不能被清空（最后的清空请求被忽略），防止删全部节点等 误操作，但是会影响列表的准确性。	1.6.0
beans	registry.register.batch	false	是否开启有注册中心的批量注册/反注册	boolean	默认true，重连或者销毁时采用批量的方式。配为false则采取旧方式。	1.6.0
beans	invoke.send.app	false	Consumer调用时是否发生信息	boolean	默认true，服务端拿到调用端的自动部署应用信息。配为false，服务端拿不 到调用者信息	1.6.0
beans	serialize.check.reference	false	序列化是否检测循环引用类型	string	默认true，针对c++等调用者进行关闭	1.6.0
beans	json.serializer.features	false	json序列化的时候，开启的特性	string	默认空，参见com.jd.fastjson.serializer.SerializerFeature，多个逗号分隔	1.6.0
beans	json.parser.features	false	json解析的时候，开启的特性	string	默认空，参见com.jd.fastjson.parser.Feature，多个逗号分隔	1.6.0

作为一级元素，全局设置（beans下的设置）的相同API操作如下：

JSFContext.putGlobalVal( "serialize.check.class" , "false" ); //beans下一级元素标签，代表全局变量

作为二级元素，接口级设置（registry、server、provider、consumer）的相同API操作如下：

registryConfig.setParameter( "app" , "jsf-dev" ); // jsf:registry下配置 providerConfig.setParameter( ".token" , "112233" ); // jsf:provider下配置，hiddenkey前面加"." consumerConfig.setParameter( ".token" , "112233" ); // jsf:consumer下配置，hiddenkey前面加"."

作为三级元素，方法级设置（method下的设置）的相同API操作如下：

methodConfig.setParameter( "aaaa" , "bbbbbb" ); // jsf:method下配置

<jsf:annotation>

一级元素，对应com.jd.jsf.gd.config.annotation.AnnotationBean
注解方式配置时使用。参见JSF用户手册#配置方式
只提供基本的设置，高级功能请使用xml或者api方式发布。

标签	属性	类型	是否必填	默认值	描述	起始版本
annotation	id	string	是		Spring的BeanId	1.0.0
annotation	basepackage	string	是		要扫描注解的包前缀	1.0.0
annotation	provider	boolean	否	true	是否扫描Provider标签	1.0.0
annotation	consumer	boolean	否	true	是否扫描Consumer标签	1.0.0

<jsf:filter>

一级元素，对应com.jd.jsf.gd.config.annotation.FilterBean
提供一个全局过滤器的入口，只针对spring配置方式（api方式没有此接口）

标签	属性	类型	是否必填	默认值	描述	起始版本
filter	id	string	是		Spring的BeanId	1.2.0
filter	class	string	是1		filter类名（继承AbstractFilter），用于newInstance	1.2.0
filter	ref	bean	是1		指定filter的实现类，优先与class	1.6.1
filter	providers	string	否	*	不填表示无，多个jsf:provider的beanId用英文逗号隔开	1.2.0
filter	consumers	string	否	*	不填表示无，多个jsf:consumer的beanId用英文逗号隔开	1.2.0

注1：ref和class二选一。

<jsf:consumerGroup>

since 1.6.0

一级元素，对应com.jd.jsf.gd.config.spring.ConsumerGroupBean
 设置一个可以包含多个alias的客户端，调用哪个alias可以切换。

标签	属性	类型	是否必填	默认值	描述	起始版本
其它属性参见jsf:consumer
consumerGroup	dstParam	int	否		目标参数（机房/分组等）索引，从0开始计数	1.6.0
consumerGroup	aliasAdaptive	boolean	否	false	是否自动适配alias，设为true当没有alias时自动引入	1.6.0
consumerGroup	groupRouter	string	否		自定义分组路由规则实现类	1.6.0

<jsf:connStrategy>

since 1.6.6-SNAPSHOT

一级元素，对应com.jd.jsf.gd.config.spring.ConnStrategyBean

 设置一个连接治理策略。

标签	属性	类型	是否必填	默认值	描述	起始版本
connStrategy	id	string	是		Spring的BeanId	1.6.6-SNAPSHOT
connStrategy	initialSize	int	否	-1	服务启动的时候建立连接数，-1代表拉取到的所有Provider数	1.6.6-SNAPSHOT
connStrategy	maxActive	int	否	-1	运行过程中维持的连接数，-1代表拉取到的所有Provider数	1.6.6-SNAPSHOT