# dcti

**Repository Path**: dwarfeng/dcti

## Basic Information

- **Project Name**: dcti
- **Description**: No description available
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2020-03-16
- **Last Updated**: 2026-09-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# DCTI

数据收集传输接口。

Data Collection Transport Interface for DwArFeng

该项目定义了通用的数据传输接口，使用此接口的项目可以互相进行数据传输通信，项目基于 `subgrade` 构建。

---

## 特性

1. 标准数据传输 DTO：`DataInfo`、`TimedValue`（毫秒时间基线 + 毫秒内纳秒偏移）。
2. 基于 FastJson 的默认 JSON 消息格式（`point_long_id`、`value`、`happened_date`、`happened_date_nano_offset`）。
3. 数据转换与排序工具：`DataInfoUtil`、`TimedValueUtil`、`CompareUtil`，支持 `Instant` 时间语义。
4. Subgrade 架构支持：`DctiHandler`、`DctiQosHandler`、`DctiQosService` 及对应实现。
5. Spring 单例配置：`com.dwarfeng.dcti.node.configuration.SingletonHandlerConfiguration`。
6. Spring XML XSD 命名空间配置（`3.0.0.a` 起）。
7. `dcti-api` 模块提供 spring-telqos 集成（`DctiCommand`）。

运行 `dcti-core/src/test` 下的示例以观察核心特性。

| 所在模块  | 示例类名                                       | 说明                                         |
|-----------|------------------------------------------------|----------------------------------------------|
| dcti-core | `com.dwarfeng.dcti.node.example.EncodeExample` | 编码示例：将 `DataInfo` 编码为 JSON 消息文本 |
| dcti-core | `com.dwarfeng.dcti.node.example.DecodeExample` | 解码示例：将 JSON 消息文本解码为 `DataInfo`  |

运行 `dcti-api/src/test` 下的示例以观察 API 扩展特性。

| 所在模块 | 示例类名                                      | 说明                                            |
|----------|-----------------------------------------------|-------------------------------------------------|
| dcti-api | `com.dwarfeng.dcti.api.example.TelqosExample` | Telqos 示例：通过 `dcti` 指令操作 DCTI QoS 服务 |

## 文档

该项目的文档位于 [docs](./docs) 目录下，包括：

### wiki

wiki 为项目的开发人员为本项目编写的详细文档，包含不同语言的版本，主要入口为：

1. [简介](docs/wiki/zh-CN/Introduction.md) - 镜像的 `README.md`，与本文件内容基本相同。
2. [目录](docs/wiki/zh-CN/Contents.md) - 文档目录。

## 安装说明

1. 下载源码。

   使用 git 进行源码下载。

   ```shell
   git clone git@github.com:DwArFeng/dcti.git
   ```

   对于中国用户，可以使用 gitee 进行高速下载。

   ```shell
   git clone git@gitee.com:dwarfeng/dcti.git
   ```

2. 项目安装。

   进入项目根目录，执行 maven 命令：

   ```shell
   mvn clean source:jar install
   ```

3. 项目引入。

   根工程坐标为 `com.dwarfeng:dcti`。在业务项目中使用时，通常按需要引入具体模块。

   如果只需要核心 DCTI 能力，在项目的 `pom.xml` 中添加如下依赖：

   ```xml
   <dependency>
       <groupId>com.dwarfeng</groupId>
       <artifactId>dcti-core</artifactId>
       <version>${dcti.version}</version>
   </dependency>
   ```

   如果需要 spring-telqos 运维指令能力，在项目的 `pom.xml` 中添加如下依赖：

   ```xml
   <dependency>
       <groupId>com.dwarfeng</groupId>
       <artifactId>dcti-api</artifactId>
       <version>${dcti.version}</version>
   </dependency>
   ```

4. enjoy it.

## 如何使用

1. 运行 `dcti-core/src/test` 下的 `EncodeExample`、`DecodeExample` 以观察核心特性。
2. 运行 `dcti-api/src/test` 下的 `TelqosExample` 以观察 spring-telqos 运维指令特性。
3. 观察项目结构，将其中的配置运用到其它的 subgrade 项目中。

### 单例模式

加载 `com.dwarfeng.dcti.node.configuration.SingletonHandlerConfiguration`， 即可获得单例模式的 `DctiHandler`、
`DctiQosHandler` 与 `DctiQosService`。 在项目的 `application-context-scan.xml` 中追加
`com.dwarfeng.dcti.node.configuration` 包中
`SingletonHandlerConfiguration` 的扫描，示例如下:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<!-- 以下注释用于抑制 idea 中 .md 的警告，实际并无错误，在使用时可以连同本注释一起删除。 -->
<!--suppress SpringXmlModelInspection -->
<beans
        xmlns:context="http://www.springframework.org/schema/context"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xmlns="http://www.springframework.org/schema/beans"
        xsi:schemaLocation="http://www.springframework.org/schema/beans
        http://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/context
        http://www.springframework.org/schema/context/spring-context.xsd"
>

   <!-- 扫描 configuration 包中的 SingletonHandlerConfiguration。 -->
    <context:component-scan base-package="com.dwarfeng.dcti.node.configuration" use-default-filters="false">
        <context:include-filter
                type="assignable"
                expression="com.dwarfeng.dcti.node.configuration.SingletonHandlerConfiguration"
        />
    </context:component-scan>
</beans>
```

同时确保容器中已存在可用的 `ServiceExceptionMapper` Bean，例如 `mapServiceExceptionMapper`。

### 多实例模式

不使用包扫描，使用 xml 或者配置类生成多个 `DctiHandlerImpl` 实例。
在项目的 `bean-definition.xml` 中追加配置，示例如下:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<!-- 以下注释用于抑制 idea 中 .md 的警告，实际并无错误，在使用时可以连同本注释一起删除。 -->
<!--suppress SpringBeanConstructorArgInspection, SpringXmlModelInspection -->
<beans
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xmlns="http://www.springframework.org/schema/beans"
        xsi:schemaLocation="http://www.springframework.org/schema/beans
        http://www.springframework.org/schema/beans/spring-beans.xsd"
>

    <!-- 第 1 个处理器实例。 -->
    <bean name="dctiHandler1" class="com.dwarfeng.dcti.impl.handler.DctiHandlerImpl"/>

    <!-- 第 2 个处理器实例。 -->
    <bean name="dctiHandler2" class="com.dwarfeng.dcti.impl.handler.DctiHandlerImpl"/>

   <!-- QoS 处理器：显式传入全部 DctiHandler Bean 组成的 Map。 -->
   <bean name="dctiQosHandler" class="com.dwarfeng.dcti.impl.handler.DctiQosHandlerImpl">
      <constructor-arg>
         <map>
            <entry key="dctiHandler1" value-ref="dctiHandler1"/>
            <entry key="dctiHandler2" value-ref="dctiHandler2"/>
         </map>
      </constructor-arg>
   </bean>

    <!-- QoS 服务。 -->
    <bean name="dctiQosService" class="com.dwarfeng.dcti.impl.service.DctiQosServiceImpl">
        <constructor-arg ref="dctiQosHandler"/>
        <constructor-arg ref="mapServiceExceptionMapper"/>
    </bean>
</beans>
```

### XSD 配置

从 `3.0.0.a` 版本开始，可以使用 `dcti` 命名空间装配 `DctiHandler` 与 `DctiQosService`。
在项目的 `application-context-dcti.xml` 中追加配置，示例如下:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<!-- 以下注释用于抑制 idea 中 .md 的警告，实际并无错误，在使用时可以连同本注释一起删除。 -->
<!--suppress SpringPlaceholdersInspection -->
<beans
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xmlns:dcti="http://dwarfeng.com/schema/dcti"
        xmlns="http://www.springframework.org/schema/beans"
        xsi:schemaLocation="http://www.springframework.org/schema/beans
        http://www.springframework.org/schema/beans/spring-beans.xsd
        http://dwarfeng.com/schema/dcti
        http://dwarfeng.com/schema/dcti/dcti.xsd"
>

    <dcti:handler/>
    <dcti:qos/>
</beans>
```

`handler` 元素可通过 `handler-name` 指定 `DctiHandler` 的 bean 名称，默认为 `dctiHandler`。
`qos` 元素可通过 `qos-handler-name`、`qos-service-name`、`handler-ref`、`sem-ref`
指定 QoS 处理器 bean 名称、QoS 服务 bean 名称、`DctiHandler` 引用和 `ServiceExceptionMapper` 引用， 默认值分别为
`dctiQosHandler`、`dctiQosService`、`dctiHandler` 和 `mapServiceExceptionMapper`。

### 任意数量的实例模式

自行设计 `DctiHandler` 的工厂类，调用构造方法生成 `DctiHandlerImpl` 实例，并按需注册到 Spring 容器中。
当前默认实现 `DctiHandlerImpl` 为无状态处理器，无需额外的启动或关闭生命周期管理。