3 Star 4 Fork 2

xson_org / xco

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

XCO


1. XCO简介

XCO(XSON common object)是一种通用的数据对象, 底层采用一种类似Map的数据结构进行数据的存储访问, 能够方便的以XML和Byte[]的方式对数据对象进行序列化和反序列化,适合同构、异构系统之间的数据传输和交换。

2. XCO生态圈

XCO生态圈

  1. xco-java:XCO Java版本;
  2. xco-js:XCO JavaScript版本,具体请参考http://xson.org/project/xco-js/
  3. xco-c :XCO C语言版本;

3. 支持的数据类型

  1. 8种基本类型(byte, boolean, short, int, long, float, double, char)和其包装类型
  2. 8种基本类型数组
  3. String
  4. String数组
  5. String集合
  6. java.util.Date
  7. java.sql.Date
  8. java.sql.Time
  9. java.sql.Timestamp
  10. BigInteger
  11. BigDecimal
  12. XCO
  13. XCO数组
  14. XCO集合

4. 版本maven使用

当前最新版本:1.0.4

maven中使用

<dependency>
	<groupId>org.xson</groupId>
	<artifactId>common-object</artifactId>
	<version>1.0.4</version>
</dependency>

5. 更新说明

1.0.4

  1. 调整取值策略,先整体取值,后OGNL取值
  2. 增加序列化时的字段过滤

1.0.3版本

  1. 增加append方法

1.0.2版本

  1. 支持Ognl表达式取值
  2. 增加getValue相关方法
  3. 增加remove方法
  4. 增加byte[]相关的序列化和反序列化操作
  5. 增加getData方法

6. 常用方法

a. 赋值

	public final void setIntegerValue(String field, int var)
		设置一个int类型的值, field为key

	public final void setStringValue(String field, String var)
		设置一个String类型的值, field为key

	//setXxx

b. 取值

	public final int getIntegerValue(String field)
		获取一个int类型的值, field为key

	public final String getStringValue(String field)
		获取一个String类型的值, field为key
	//getXxx

c. 序列化

	public String toXMLString()	
		把XCO对象以XML方式进行序列化

	public static XCO fromXML(String xml)
		从一个XML字符串反序列化为XCO对象

	public String toJSON()
		把XCO对象以JSON方式进行序列化

	public byte[] toBytes() {
		把XCO对象以byte[]方式进行序列化

	public byte[] toBytes(int offsetLength) 
		把XCO对象以byte[]方式进行序列化,并保留偏移内容

	public static XCO fromBytes(byte[] buffer) 
		从byte[]反序列化为XCO对象
		
	public static XCO fromBytes(byte[] buffer, int offsetLength) 
		从byte[]的指定偏移长度开始,反序列化为XCO对象

7. 整合XSON

XCO对象的toBytesfromBytes方法需要XSON框架支持,具体的使用操作如下:

a. 添加Maven依赖

<dependency>
    <groupId>org.xson</groupId>
    <artifactId>xson</artifactId>
    <version>1.0.2</version>
</dependency>

b. 编辑xson.properties配置文件

# Support for XCO
xco=true

提示 关于XSON具体可参考http://xson.org/project/xson/1.0.2/

7. 使用示例

	XCO xco = new XCO();

	// 设置基本类型
	xco.setByteValue("byteVal", (byte) 3);
	xco.setBooleanValue("booleanVal", true);
	xco.setShortValue("shortVal", (short) 5);
	xco.setIntegerValue("intVal", 2);
	xco.setLongValue("longVal", 2L);
	xco.setFloatValue("floatVal", 2.0F);
	xco.setDoubleValue("doubleVal", -0.3D);
	xco.setCharValue("charVal", 'x');

	// 设置对象类型
	xco.setStringValue("stringVal", "hello world");
	xco.setDateTimeValue("dateTimeVal", new java.util.Date());
	xco.setDateValue("dateVal", new java.sql.Date(System.currentTimeMillis()));
	xco.setTimeValue("TimeVal", new java.sql.Time(System.currentTimeMillis()));
	xco.setBigIntegerValue("bigIntegerVal", new BigInteger("1380000"));
	xco.setBigDecimalValue("bigDecimal", new BigDecimal("1380000.9999"));
	xco.setXCOValue("xcoVal", new XCO());

	// 设置数组
	xco.setIntegerArrayValue("intArray", new int[] { 1, 3, 5, 8 });
	xco.setStringArrayValue("stringArray", new String[] { "aa", "bb", "cc" });

	// 设置集合
	List<String> list = new ArrayList<String>();
	xco.setStringListValue("stringList", list);
	Set<String> set = new TreeSet<String>();
	xco.setStringSetValue("stringSet", set);

	// 序列化为XML字符串
	String xml = xco.toXMLString();
	// 从XML字符串反序列化
	XCO newXco = XCO.fromXML(xml);

	// 序列化为byte[]
	byte[] buffer = xco.toBytes();
	// 从byte[]反序列化
	XCO newXco1 = XCO.fromBytes(buffer);

	// 取值
	byte byteVal = xco.getByteValue("byteVal");
	boolean booleanVal = xco.getBooleanValue("booleanVal");
	short shortVal = xco.getShortValue("shortVal");
	int intVal = xco.getIntegerValue("intVal");
	long longVal = xco.getLongValue("longVal");
	float floatVal = xco.getFloatValue("floatVal");
	double doubleVal = xco.getDoubleValue("doubleVal");
	String stringVal = xco.getStringValue("stringVal");
	XCO xcoVal = xco.getXCOValue("xcoVal");	

8. XML表示

上面使用示例中的XCO对象xco的XML表示如下:

<?xml version="1.0" encoding="UTF-8"?>
<X>
	<B K="byteVal" V="3"/>
	<O K="booleanVal" V="true"/>
	<H K="shortVal" V="5"/>
	<I K="intVal" V="2"/>
	<L K="longVal" V="2"/>
	<F K="floatVal" V="2.0"/>
	<D K="doubleVal" V="-0.3"/>
	<C K="charVal" V="x"/>
	<S K="stringVal" V="hello world"/>
	<A K="dateTimeVal" V="2016-09-02 16:58:25"/>
	<E K="dateVal" V="2016-09-02"/>
	<G K="TimeVal" V="16:58:25"/>
	<K K="bigIntegerVal" V="1380000"/>
	<M K="bigDecimal" V="1380000.9999"/>
	<X K="xcoVal"/>
	<IA K="intArray" V="1,3,5,8"/>
	<SA K="stringArray">
		<S V="aa"/>
		<S V="bb"/>
		<S V="cc"/>
	</SA>
	<SL K="stringList"/>
	<SS K="stringSet"/>
</X>

说明

a. 以此为例:<H K="shortVal" V="5"/>
	H: 数据类型标识,当前标示short类型
	K: key
	V: 具体数值
b. 数据类型标识说明
	B: byte
	H: short
	I: int
	L: Long
	F: float
	D: double
	C: char
	O: boolean
	S: String
	X: xco
	A: date
	E: sql.date
	G: sql.time
	J: sql.timestamp
	K: bigInteger
	M: bigDecimal
	..
	其他详见:org.xson.common.object.DataType

9. 类图

XCO设计图

10. 官方网站

http://xson.org/

11. 沟通交流

QQ群:518522232**(请备注关注的项目)**

邮箱:xson_org@126.com

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "{}" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright {yyyy} {name of copyright owner} Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

XSON Common Object 展开 收起
Java
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/xsonorg/xco.git
git@gitee.com:xsonorg/xco.git
xsonorg
xco
xco
master

搜索帮助