Download the PHP package teamone/teamone-wp-db-orm without Composer

Teamone WordPress Database ORM

Teamone WordPress Database ORM 是一款由【霆万平头哥】开发的PHP数据库操作组件，旨在为WordPress开发者提供强大而灵活的数据库操作解决方案。该组件无需任何其他依赖，可即插即用。

背景

在实际开发中，许多应用需要连接多个不同的数据库实例或实现读写分离等高级功能。然而，诸如WordPress等框架内置的数据库操作类通常存在一些限制，无法轻松支持这些复杂功能需求。

特别是在WordPress框架中，由于其插件机制，可能出现不同插件之间的类加载和配置冲突问题，给开发者带来了不便。

解决方案

Teamone WordPress Database ORM 提供了一套完整的解决方案，通过对插件之间进行隔离，解决了类加载和配置冲突问题，使得每个插件都可以独立地安装和使用该组件，互不干扰。此外，该组件还提供了丰富的功能模块，大大增强了在WordPress中操作数据库的能力。

主要特性

1. 连接器与配置：支持连接多个数据库实例，并提供灵活的配置选项。

2. 数据库接口层：提供统一的数据库操作接口，简化开发者的操作。无论是简单的增删改查操作，还是复杂的数据库操作，都能通过简洁的API轻松实现。

3. 语法分析器与SQL编译器：支持复杂的SQL语句，并提供高效的编译器。即使是最复杂的查询也能被轻松处理，同时还能通过内置的SQL优化器提升查询性能。

4. 事务管理器：提供事务管理功能，确保数据库操作的原子性和一致性。无论是在数据更新、插入还是删除时，都能保证数据操作的完整性，避免出现数据不一致的情况。

5. 分页管理器：支持结果集的分页操作，便于处理大量数据。通过分页管理器，可以轻松实现数据的分页展示，提升用户体验，同时减轻数据库负载压力。

6. 游标管理：提供游标操作功能，方便对结果集进行遍历和操作。无论是需要逐行处理数据，还是对数据进行批量操作，都能通过游标管理器实现高效处理。

7. 防SQL注入：内置防SQL注入机制，提高系统安全性。通过参数化查询等技术手段，有效防止恶意注入攻击，保护系统数据安全。

8. SQL执行日志：记录SQL执行日志，便于排查和优化性能问题。通过详细的SQL执行日志，可以及时发现并解决潜在的性能瓶颈，提升系统的响应速度和稳定性。

9. 丰富的查询功能：支持多种查询操作，包括条件查询、聚合查询等。无论是简单的数据查询，还是复杂的数据分析，都能通过丰富的查询功能轻松实现。

10. 支持读写分离：提供读写分离功能，优化数据库性能。通过将读操作和写操作分离到不同的数据库实例，可以有效提升系统的并发处理能力和响应速度。

11. 支持连接实例切换：允许动态切换数据库连接实例。在多数据库环境下，可以根据实际情况灵活选择数据库连接，提升系统的可扩展性和灵活性。

12. 支持表前缀切换：支持动态切换数据库表前缀，增强了组件的灵活性。通过表前缀切换功能，可以轻松实现数据库的分库分表管理，提高系统的性能和可维护性。

项目目标

通过提供强大而灵活的数据库操作组件，Teamone WordPress Database ORM 旨在帮助WordPress开发者解决多数据库连接、读写分离等问题，提高开发效率，降低系统复杂度，为WordPress主题和插件开发提供更好的支持和扩展性。

通过提供强大而灵活的数据库操作组件，Teamone WordPress Database ORM 旨在帮助WordPress开发者解决多数据库连接、读写分离等问题，提高开发效率，降低系统复杂度，为WordPress主题和插件开发提供更好的支持和扩展性。同时，我们致力于不断优化和完善组件功能，为用户提供更加稳定、高效的数据库操作解决方案。

功能模块

1. 连接器(连接、配置)
2. 数据库接口层
3. 语法分析器
4. SQL编译器
5. 事务管理器
6. 分页管理器
7. 游标管理
8. 防SQL注入
9. SQL执行日志
10. 支持丰富的查询
11. 支持读写分离
12. 支持连接实例切换
13. 支持表前缀切换

测试表

Composer 安装

• 安装 Simple Database

Composer 依赖工具安装

注意，如果您需要对 Simple Database 进行扩展，在开发过程中可以安装下列工具，在投入生产是不需要使用的。

1. 安装调试工具 VarDumper

2. 安装静态代码分析工具

3. 安装 PHPUnit

数据库连接配置

default 声明默认连接，取值为 connections 的 key。connections 可以定义多个连接。

单元测试解释

在 test/Unit 目录中，编写了详细的测试用例。

我们来看下 test 目录结构：

• trait ConnectTrait 说明

ConnectTrait::db() 用于获取连接，setupSomeFixtures() 表示前置执行，tearDownSomeFixtures() 表示后置执行。

• 简单的单元测试类声明

执行测试：

单元测试

1. 执行指定目录所有用例

2. 执行指定文件

3. 执行 TeamoneWpDbOrmBaseTest 用例

4. 执行 TeamoneWpDbOrmBaseTest::test1 用例

数据库连接

为了简化，后续我们都使用 DB 作为 Manager 的别名

1. 数据库连接，提供实现类

2. 数据库连接，提供匿名实现类

3. 查询日志

4. 原生查询与占位符

5. 指定连接查询(切换实例)

注意：当没有调用 connection() 方法时，使用的时默认连接配置。

6. SQL分析

数据库查询

1. 从表中检索所有行

2. 从数据表中获取单行或单列

如果你只需要从数据表中获取一行数据，你可以使用 first 方法。

3. 可以使用 value 方法从记录中获取单个值。

4. 如果是通过 id 字段值获取一行数据，可以使用 find 方法

5. 获取一列的值

如果你想获取包含单列值的集合，则可以使用 pluck 方法。

您可以通过向 pluck 方法提供第二个参数来指定结果集中应将其用作键的列：

分块结果

如果您需要处理成千上万的数据库记录，这个方法一次检索一小块结果，并将每个块反馈到闭包函数中进行处理。 例如，让我们以一次 2 条记录的块为单位检索整个 users 表。:

您可以通过从闭包中返回 false 来停止处理其他块:

聚合

总数：

最大值：

最小值：

平均值：

平均值：

总和：

Select

1. select 指定字段

• distinct 方法会强制让查询返回的结果不重复

• 如果你已经有了一个查询构造器实例，并且希望在现有的查询语句中加入一个字段，那么你可以使用 addSelect 方法

原生表达式

• 创建一个原生表达式(使用原生表达式，你需要避免SQL注入漏洞)

• 原生方法 selectRaw

• 原生方法 whereRaw / orWhereRaw

• 原生方法 havingRaw / orHavingRaw

• 原生方法 orderByRaw

• 原生方法 groupByRaw

Joins 连接

• Inner Join 语句

• Left Join

• Right Join

• 子连接查询

Unions

• Union 联合查询

• Union All 联合查询

基础的 Where 语句

• Where 语句

• 默认使用 = 操作符

• 可以使用数据库支持的任意操作符

• 支持数组条件参数，默认是 = 操作符

Or Where 语句

• orWhere 方法接收的参数和 where 方法接收的参数一样

• 如果您需要在括号内对 or 条件进行分组，那么可以传递一个闭包作为 orWhere 方法的第一个参数

其他 Where 语句

• whereBetween / orWhereBetween , whereBetween 方法是用来验证字段的值是否在给定的两个值之间

• whereNotBetween / orWhereNotBetween, whereNotBetween 方法是用来验证字段的值是否不在给定的两个值之间

whereIn / whereNotIn / orWhereIn / orWhereNotIn

• whereIn 方法是用来验证一个字段的值是否在给定的数组中

• whereNotIn

whereNull / whereNotNull / orWhereNull / orWhereNotNull

• whereNull 方法是用来验证给定字段的值是否为 NULL

• whereNotNull

whereDate / whereMonth / whereDay / whereYear / whereTime

• whereDate 方法是用来比较字段的值与给定的日期值是否相等 （年 - 月 - 日）

• whereMonth 方法是用来比较字段的值与给定的月份是否相等（月）

• whereDay 方法是用来比较字段的值与一个月中给定的日期是否相等 （日）

• whereYear 方法是用来比较字段的值与给定的年份是否相等（年）

• whereTime 方法是用来比较字段的值与给定的时间是否相等（时：分: 秒）

whereColumn / orWhereColumn

• whereColumn 方法是用来比较两个给定的字段的值是否相等

• 您也可以传递一个比较运算符来作为 whereColumn 方法的第二个参数，如下

• 您还可以向 whereColumn 方法中传递一个数组。数组中的条件将会被看作是 and 关系

逻辑分组

• 有时您可能需要将括号内的几个 “where” 子句分组

Where Exists 语句

• whereExists 方法允许你使用 where exists SQL 语句

子查询 Where 语句

• 有时候，您可能需要构造一个 where 子句，将子查询的结果与给定值进行比较。您可以通过向 where 方法传递一个闭包和一个值来完成此操作。

• 您可能需要构造一个 “where” 子句，将列与子查询的结果进行比较。

Ordering, Grouping, Limit & Offset

• orderBy 方法允许你通过给定字段对结果集进行排序。 orderBy 的第一个参数应该是你希望排序的字段，第二个参数控制排序的方向，可以是 asc 或 desc

• 如果你需要使用多个字段进行排序，你可以多次引用 orderBy

• latest & oldest 方法, 方法让你以一种便捷的方式通过日期进行排序。它们默认使用 created_at 列作为排序依据。当然，你也可以传递自定义的列名

• 随机排序, inRandomOrder 方法被用来将结果进行随机排序。例如，你可以使用此方法随机找到一个用户

• 删除已经存在的所有排序, reorder 方法允许你删除已经存在的所有排序，如果你愿意，可以在之后附加一个新的排序。例如，你可以删除所有已存在的排序

Grouping

• groupBy & having 方法

• groupBy & having 方法

Limit & Offset

• skip & take 方法, 要限制结果的返回数量，或跳过指定数量的结果，你可以使用 skip 和 take 方法

• 你也可以使用 limit 和 offset 方法，这些方法在功能上分别等效于 take 和 skip 方法

插入语句

• insert 方法用于插入记录到数据库中

• insert 批量插入

• insertOrIgnore 方法在将记录插入数据库时将忽略重复记录错误

• 如果数据表有自增 ID ，使用 insertGetId 方法来插入记录可以返回 ID 值

• upsert upsert 方法用于插入不存在的记录，并使用您指定的新值更新已存在的记录。 方法的第一个参数由要插入或更新的值组成，而第二个参数列出了唯一标识关联表中记录的列。 该方法的第三个也是最后一个参数是一个列数组，如果数据库中已存在匹配的记录，则应更新这些列。

在示例中，会尝试插入两条记录，如果记录存在与 name 和 password 列相同的值，将会更新 price 列的值。

更新语句

• update

• 更新或新增 有时您可能希望更新数据库中的现有记录，或者如果不存在匹配记录则创建它。 在这种情况下，可以使用 updateOrInsert 方法。 updateOrInsert 方法接受两个参数：一个用于查找记录的条件数组，以及一个包含要更该记录的键值对数组。

自增与自减

• 自增

• 自减

删除语句

• Delete

锁

• 悲观锁，共享锁 (lock in share mode)

查询构造器也包含了一些能够帮助您在 select 语句中实现「悲观锁」的函数。 要执行一个含有「共享锁」的语句，您可以在查询中使用 sharedLock 方法。 共享锁可防止指定的数据列被篡改，直到事务被提交为止。

• 排他锁 (for update)

执行原生 SQL 查询

• SELECT

• INSERT

• DELETE

• 执行普通查询

部分数据库语句没有返回值。你可以使用statement 方法：

• 数据库事务

• Exists 判断记录是否存在

• doesntExist 判断记录是否存在

• 分页

• 简单分页

• 游标分页

• 分页参数

• 使用游标

• 使用游标 2

• 惰性查询

• 惰性查询

• 使用 ID 分页

• 将给定列的值连接为字符串

模型 Model

无论使用模型类还是DB类，都必须执行 DB::resolverDatabaseConfig(DatabaseConfig::class) 方法进行初始化配置。

• 声明模型类

其中，$table 属性是必填项，如果未声明 $tablePrefix ，则采用配置文件DatabaseConfig::getConnectionConfig()['connections']['prefix']字段作为前缀。

如果未声明 $connection 属性，则采用配置文件DatabaseConfig::getConnectionConfig()['default'] 字段作为默认连接。

• 模型类使用

• 一次查询一次调用 newQuery()

• 选择连接

• 表前缀切换

• 查询指定连接的查询日志

• 指定连接、表前缀、表名

WordPress 引入方式

假设现在有个 WordPress 插件，名为 plugin-first，插件所在目录即: wp-content/plugins/plugin-first， 插件入口文件通常与插件名相同，如：plugin-first.php，在入口文件，我们声明如下代码：

如上例，我们要实现两个方法，getConnectionConfig()用于初始化数据库配置；getEntryFile()，提供入口文件，用于在 WordPress 插件机制中起到隔离作用。

• 查询

参考文档

• 单元测试 https://phpunit.readthedocs.io/zh_CN/latest/index.html