Hmily 开源项目安装与使用指南

---

1. 项目目录结构及介绍

Hmily 是一个分布式事务解决方案，旨在提供高性能和简单易用的分布式事务服务。以下是 hmily 项目的典型目录结构概览及其主要组件介绍：

.
├── hmily-api               # 接口定义模块
│   └── ...
├── hmily-core              # 核心业务逻辑实现
│   ├── config              # 配置相关
│   ├── constant            # 常量定义
│   └── ...
├── hmily-dao               # 数据访问对象层
│   └── mysql               # MySQL相关的DAO实现
├── hmily-dubbo             # Dubbo适配模块
├── hmily-kafka             # Kafka事件通知模块
├── hmily-mysql             # 示例数据库脚本
├── hmily-redis             # Redis客户端操作封装
├── hmily-spring-boot-starter # Spring Boot集成启动器
│   └── starter-config      # 启动器配置
├── hmily-storage           # 事务状态存储实现
│   ├── mysql               # MySQL存储实现
│   └── redis               # Redis存储实现
├── examples                # 示例应用，展示如何集成Hmily
│   ├── dubbo               # 使用Dubbo的示例
│   └── spring-boot        # 使用Spring Boot的示例
├── documentation           # 文档资料
├── build.gradle            # Gradle构建脚本
└── README.md               # 项目快速入门指南

每个模块都有其特定职责，确保系统各部分高内聚低耦合，便于开发、维护和扩展。

---

2. 项目的启动文件介绍

在示例应用中，以Spring Boot为例，启动文件通常位于某个Spring Boot模块下的main目录下，例如examples/spring-boot-starter/src/main/java/com/example/demo/DemoApplication.java。一个典型的Spring Boot启动类看起来如下：

package com.example.demo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
import org.springframework.context.annotation.Import;

import cn.dromara.hmily.demo.config.HmilyConfig;

@SpringBootApplication
@EnableDiscoveryClient
@Import(HmilyConfig.class)
public class DemoApplication {
    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }
}

这里通过@SpringBootApplication注解简化了配置，@EnableDiscoveryClient用于启用服务发现，而@Import(HmilyConfig.class)导入自定义的Hmily配置类，确保Hmily框架能够正确初始化并融入到Spring Boot应用中。

---

3. 项目的配置文件介绍

Hmily的配置通常在Spring Boot项目中是通过application.properties或application.yml文件进行管理的。以下是一些基础配置示例：

# application.yml 示例片段

hmily:
  transaction:
    mode: 'SIMPLE' # 事务模式，支持SIMPLE/TCC/AT等
    storage-type: 'MYSQL' # 存储类型，可以是MySQL或Redis
    redis:
      host: localhost
      port: 6379
    mysql:
      url: jdbc:mysql://localhost:3306/hmily?useSSL=false&serverTimezone=UTC
      username: root
      password: password
    id-generator: 'snowflake' # ID生成策略，默认雪花算法
  dubbo:
    consumer:
      retry-times: '0'
      check: false

这里的配置项指定了Hmily的运行模式（如SIMPLE、TCC、AT模式），事务状态的存储方式及相应的数据库连接信息，还有ID生成的方式等。根据具体应用场景调整这些配置，确保Hmily能够符合项目需求高效工作。

---

以上是对Hmily开源项目关键部分的简要介绍。实际部署与开发时，还需详细阅读项目文档及各模块的README文件，以便更深入地理解和应用。