# xmlTool

**Repository Path**: MEliauk/xml-tool

## Basic Information

- **Project Name**: xmlTool
- **Description**: 注解定义xml格式生成文档
- **Primary Language**: Java
- **License**: MulanPSL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-03-02
- **Last Updated**: 2022-06-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# xmlTool

#### 介绍
注解定义xml格式生成文档

#### 注解说明

#####  @IDocument
- `@IDocument(name = "Object")`，
- 设置父元素节点类型名称为Object
#####  @IElement
- `@IElement(name = "Property", params = { "Name" }, paramsValue = { "name" })` 
-  注解字段为节点元素 `name`该节点元素名称，`params`该元素属性名称，`paramsValue`该元素属性值，字段值为此元素的值


#####  @IAttribute
 - `@IAttribute(name = "ID")`
 - 注解字段为父类属性，`name`为属性名称，该字段值为此属性值


#### 使用说明

1. 实体类标记为xml文档类型添加注解`@IDocument`
2. 实体类继承 `BaseObject`
3. 重新父类`toObject`方法，`return new XMLUtil(this).toElement();`
4. 创建xml对象 `MXML xml = new MXML();`调用`addObject(实体类对象)`
5. 写出xml文档 `new XMLUtil(xml).XMLWriter(xml, 文件路径以及名称);`

注意：BaseObject中可添加父节点属性，MXML对象是根节点

**MXML类，用户可以实现`XML`接口，继承`XMLObj`
XMLUtil类，若需不同格式的xml文档可实现`XMLogic`接口，继承`XMLObj`，重写具体方法**

生成xml格式如下
![Image text](./src/img/xml.png)