MiniDao 使用手册

MiniDao 使用手册

1. 项目目录结构及介绍

MiniDao 是一个基于 SpringJdbc 和 Freemarker 的轻量级 JAVA 持久层框架，其设计用于简化开发过程，提供类似 MyBatis 的SQL分离能力和逻辑标签处理。下面概述了其典型的项目目录结构及其主要组成部分：

• docs: 包含项目相关文档，如指南和示例。
• minidao-pe-example: 提供了一个应用示例，展示如何在实际项目中集成 MiniDao。
• minidao-pe-framework: 框架的核心部分，包含了MiniDao的主要API和逻辑。
• gitattributes, gitignore: 版本控制相关的配置文件。
• LICENSE, README.md: 许可协议和项目简介文件。
• pom.xml: Maven项目对象模型文件，定义了项目构建过程和依赖关系。

核心开发组件集中在源码和资源文件夹中，其中src/main/java存放业务逻辑和持久化接口，而src/main/resources则包含SQL模板和其他配置。

2. 项目的启动文件介绍

对于一个基于MiniDao的项目，启动点通常不直接体现在MiniDao库本身，而是整合到你的应用程序中，如Spring Boot应用。虽然具体的启动文件未直接给出，但假设你采用Spring Boot作为基础框架，启动点通常是位于主应用程序类，该类被标记为@SpringBootApplication注解，例如：

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

在这个上下文中，MiniDao的初始化和配置将通过Spring Boot的自动配置或者自定义配置来完成。

3. 项目的配置文件介绍

Spring Boot 配置示例

在Spring Boot应用中，MiniDao的配置可能包含在application.properties或application.yml文件内，以确保Spring JDBC和相关的MiniDao配置生效。这里是一个简化的配置例子：

# application.yml 示例
spring:
  datasource:
    url: jdbc:mysql://localhost:3306/minidao_db
    username: root
    password: yourpassword
    driver-class-name: com.mysql.cj.jdbc.Driver

minidao:
  config-location: classpath:/sqlmap/minidao.sql # SQL映射文件位置
  annotation-package: com.example.minidao.entity # 注解扫描包路径

XML 配置示例（传统Spring）

如果你不是在使用Spring Boot，那么配置可能会存在于XML配置文件中，比如applicationContext.xml：

<bean id="dataSource" class="org.springframework.jdbc.datasource.DriverManagerDataSource">
  <property name="driverClassName" value="com.mysql.jdbc.Driver"/>
  <property name="url" value="jdbc:mysql://localhost:3306/minidao_db"/>
  <property name="username" value="root"/>
  <property name="password" value="yourpassword"/>
</bean>

<!-- MiniDao配置 -->
<bean id="minidaoInterceptor" class="com.minidao.interceptor.MinidaoInterceptor"/>
<bean id="sqlSessionFactory" class="com.minidao.core.SqlSessionFactory">
  <property name="dataSource" ref="dataSource"/>
  <property name="configLocation" value="classpath:minidao-config.xml"/>
  <!-- 其他MiniDao特定配置 -->
</bean>

请注意，具体配置细节可能会随版本更新而变化，因此建议参考项目最新文档或源码中的注释获取最新的配置指引。