SQLToy ORM 项目使用教程

SQLToy ORM 项目使用教程

sagacity-sqltoyJava真正智慧的ORM框架，除具有JPA功能外，具有最佳的sql编写模式、独创的缓存翻译、最优化的分页、并提供无限层级分组汇总、同比环比、行列转换、树形排序汇总、sql自适配不同数据库、分库分表、多租户、数据加解密、脱敏等痛点问题的解决方案!项目地址:https://gitcode.com/gh_mirrors/sa/sagacity-sqltoy

1. 项目的目录结构及介绍

SQLToy ORM 项目的目录结构清晰，便于管理和开发。以下是主要的目录和文件介绍：

sagacity-sqltoy/
├── src/
│   ├── main/
│   │   ├── java/
│   │   │   ├── org/
│   │   │   │   ├── sagacity/
│   │   │   │   │   ├── sqltoy/
│   │   │   │   │   │   ├── dao/
│   │   │   │   │   │   ├── model/
│   │   │   │   │   │   ├── service/
│   │   │   │   │   │   ├── utils/
│   │   │   │   │   │   ├── SqlToyContext.java
│   │   │   │   │   │   ├── SqlToyCRUDService.java
│   │   │   │   │   │   └── ...
│   │   │   │   │   └── ...
│   │   │   │   └── ...
│   │   │   └── ...
│   │   ├── resources/
│   │   │   ├── application.yml
│   │   │   ├── sqltoy-config.xml
│   │   │   └── ...
│   │   └── ...
│   ├── test/
│   │   ├── java/
│   │   │   ├── org/
│   │   │   │   ├── sagacity/
│   │   │   │   │   ├── sqltoy/
│   │   │   │   │   │   ├── test/
│   │   │   │   │   │   └── ...
│   │   │   │   │   └── ...
│   │   │   │   └── ...
│   │   │   └── ...
│   │   └── ...
│   └── ...
├── .gitignore
├── LICENSE
├── README.md
└── pom.xml

主要目录和文件说明：

• src/main/java/org/sagacity/sqltoy/: 包含项目的主要代码，如 DAO、Model、Service 和工具类等。
• src/main/resources/: 包含项目的配置文件，如 application.yml 和 sqltoy-config.xml。
• src/test/java/org/sagacity/sqltoy/test/: 包含项目的测试代码。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• pom.xml: Maven 项目配置文件。

2. 项目的启动文件介绍

SQLToy ORM 项目的启动文件主要位于 src/main/java/org/sagacity/sqltoy/ 目录下。以下是主要的启动文件介绍：

• SqlToyContext.java: 项目的核心配置和交换区，负责初始化和配置整个 SQLToy ORM 框架。
• SqlToyCRUDService.java: 提供基本的 CRUD 操作服务。

启动流程：

1. 加载 application.yml 和 sqltoy-config.xml 配置文件。
2. 初始化 SqlToyContext，配置数据库连接和其他相关参数。
3. 启动项目，开始处理数据库操作。

3. 项目的配置文件介绍

SQLToy ORM 项目的配置文件主要位于 src/main/resources/ 目录下。以下是主要的配置文件介绍：

• application.yml: 包含项目的全局配置，如数据库连接信息、日志配置等。
• sqltoy-config.xml: 包含 SQLToy ORM 框架的详细配置，如 SQL 映射、缓存配置等。

application.yml 示例：

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/test
    username: root
    password: root
    driver-class-name: com.mysql.cj.jdbc.Driver

sqltoy-config.xml 示例：

<sqltoy:config>
    <sql id="sample_query">
        <![CDATA[
            select * from sample_table where status = :status
        ]]>
    </sql>
</sqltoy:config>

sagacity-sqltoyJava真正智慧的ORM框架，除具有JPA功能外，具有最佳的sql编写模式、独创的缓存翻译、最优化的分页、并提供无限层级分组汇总、同比环比、行列转换、树形排序汇总、sql自适配不同数据库、分库分表、多租户、数据加解密、脱敏等痛点问题的解决方案!项目地址:https://gitcode.com/gh_mirrors/sa/sagacity-sqltoy