SafeMySQL 开源项目使用教程

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

SafeMySQL 项目的目录结构相对简单，主要包含以下文件：

safemysql/
├── .gitignore
├── LICENSE
├── README.md
├── composer.json
└── safemysql.class.php

• .gitignore: 用于指定 Git 版本控制系统忽略的文件和目录。
• LICENSE: 项目的许可证文件，SafeMySQL 使用 Apache-2.0 许可证。
• README.md: 项目说明文档，包含项目的基本介绍、使用方法和示例。
• composer.json: Composer 依赖管理文件，用于管理项目的依赖关系。
• safemysql.class.php: 项目的主要文件，包含 SafeMySQL 类的定义。

2. 项目的启动文件介绍

SafeMySQL 项目的启动文件是 safemysql.class.php。该文件定义了 SafeMySQL 类，提供了安全且方便的 MySQL 查询处理功能。以下是该文件的主要内容：

class SafeMySQL {
    protected $conn;
    protected $stats;
    protected $emode;
    protected $exname;
    protected $defaults = array(
        'host' => 'localhost',
        'user' => 'root',
        'pass' => '',
        'db' => 'test',
        'port' => NULL,
        'socket' => NULL,
        'pconnect' => FALSE,
        'charset' => 'utf8',
        'errmode' => 'exception', // or 'error'
        'exception' => 'Exception' // Exception class name
    );

    const RESULT_ASSOC = MYSQLI_ASSOC;
    const RESULT_NUM = MYSQLI_NUM;

    function __construct($opt = array()) {
        $opt = array_merge($this->defaults, $opt);
        $this->emode = $opt['errmode'];
        $this->exname = $opt['exception'];
        if (isset($opt['mysqli'])) {
            if ($opt['mysqli'] instanceof mysqli) {
                $this->conn = $opt['mysqli'];
                return;
            } else {
                $this->error("mysqli instance expected");
            }
        }
        // 其他初始化代码
    }

    // 其他方法定义
}

3. 项目的配置文件介绍

SafeMySQL 项目的配置主要通过 safemysql.class.php 文件中的构造函数参数进行。以下是配置项的介绍：

• host: 数据库主机地址，默认为 localhost。
• user: 数据库用户名，默认为 root。
• pass: 数据库密码，默认为空。
• db: 数据库名称，默认为 test。
• port: 数据库端口，默认为 NULL。
• socket: 数据库 socket 文件路径，默认为 NULL。
• pconnect: 是否使用持久连接，默认为 FALSE。
• charset: 数据库字符集，默认为 utf8。
• errmode: 错误处理模式，默认为 exception，可选 error。
• exception: 异常类名称，默认为 Exception。

在实例化 SafeMySQL 类时，可以通过传递一个包含这些配置项的数组来进行配置：

$options = array(
    'host' => '127.0.0.1',
    'user' => 'myuser',
    'pass' => 'mypassword',
    'db' => 'mydatabase',
    'charset' => 'utf8mb4'
);
$db = new SafeMySQL($options);

通过这种方式，可以灵活地配置 SafeMySQL 以适应不同的数据库环境和需求。