当前位置：Gxlcms > PHP教程 > 超轻的PHP数据库工具包

超轻的PHP数据库工具包

时间：2021-07-01 10:21:17 帮助过：44人阅读

一个很轻的 PHP 数据库工具包，诞生时间两天（足以证明很轻了 ）。
两个类，一个 Connection 管理 PDO 连接（支持多数据库），一个 QuickQuery 用来快速执行数据库操作（不用在 PDO 和 PDOStatement 之间来回折腾）
不用下载，在线就能看完。
  1. use Persistence\DbAccess;
  3. // 在框架初始化的地方添加连接信息
  4. DbAccess\Connection::add(
  5. 'default',
  6. 'sqlite',
  7. '/db/mydb.sqlite',
  8. null, null, false
  9. );
  11. // 下面是使用
  12. $conn = DbAccess\Connection::instance('default');
  14. // 查询
  15. $query = new DbAccess\QuickQuery($conn);
  16. $query->prepare('select :name as name')->execute(array(':name'=>'tonyseek'));
  18. // 对象直接作为迭代器产生数据数组
  19. foreach($query as $i) {
  20. var_dump($i);
  21. }
  23. // 如果有偏执的话，输出响应之前手动断开连接
  24. DbAccess\Connection::disconnectAll();
  1. namespace Persistence\DbAccess;
  2. use PDO, ArrayObject, DateTime;
  3. use LogicException, InvalidArgumentException;
  5. /**
  6. * 快捷查询通道
  7. *
  8. * @version 0.3
  9. * @author tonyseek
  10. * @link http://stu.szu.edu.cn
  11. * @license http://www.opensource.org/licenses/mit-license.html
  12. * @copyright StuCampus Development Team, Shenzhen University
  13. *
  14. */
  15. class QuickQuery implements \IteratorAggregate
  16. {
  17. /**
  18. * 数据库连接
  19. *
  20. * @var \Persistence\DbAccess\Connection
  21. */
  22. private $connection = null;
  24. /**
  25. * PDO Statement
  26. *
  27. * @var PDOStatement
  28. */
  29. private $stmt = null;
  31. /**
  32. * 被检查参数集
  33. *
  34. * @var array
  35. */
  36. private $checkedParams = array();
  39. /**
  40. * 构造查询通道
  41. *
  42. * @param \Persistence\DbAccess\Connection $connection 数据库连接
  43. */
  44. public function __construct(Connection $connection)
  45. {
  46. $this->connection = $connection;
  47. }
  49. /**
  50. * 预编译 SQL 语句
  51. *
  52. * @param string $sqlCommand SQL语句
  53. * @return \Persistence\DbAccess\QuickQuery
  54. */
  55. public function prepare($sqlCommand)
  56. {
  57. // 从连接获取 PDO, 并对 SQL 语句执行 prepare, 产生 PDO Statement
  58. $this->stmt = $this->connection->getPDO()->prepare($sqlCommand);
  59. // 修改 PDO Statement 模式为关联数组数据
  60. $this->stmt->setFetchMode(PDO::FETCH_ASSOC);
  61. // 返回方法链
  62. return $this;
  63. }
  65. /**
  66. * 执行数据查询
  67. *
  68. * @throws PDOException
  69. * @return \Persistence\DbAccess\QuickQuery
  70. */
  71. public function execute($params = array())
  72. {
  73. $stmt = $this->getStatement();
  75. // 参数检查
  76. $diff = array_diff($this->checkedParams, array_keys($params));
  77. if (count($this->checkedParams) && count($diff)) {
  78. throw new InvalidArgumentException('缺少必备参数：'.implode(' | ', $diff));
  79. }
  81. // 将 PHP 数据类型对应到数据库数据类型
  82. foreach($params as $key => $value) {
  83. $type = null;
  84. switch(true) {
  85. case is_int($value):
  86. $type = PDO::PARAM_INT;
  87. break;
  88. case is_bool($value):
  89. $type = PDO::PARAM_BOOL;
  90. break;
  91. case ($value instanceof DateTime):
  92. $type = PDO::PARAM_STR;
  93. $value = $value->format(\DateTime::W3C);
  94. break;
  95. case is_null($value):
  96. $type = PDO::PARAM_NULL;
  97. break;
  98. default:
  99. $type = PDO::PARAM_STR;
  100. }
  102. $stmt->bindValue($key, $value, $type);
  103. }
  105. $stmt->execute();
  106. $this->checkedParams = array(); // 清空参数检查
  107. return $this;
  108. }
  110. /**
  111. * 获取 Statement 对象
  112. *
  113. * 返回对象可以被绑定参数重新执行, 也可以被当作迭代器遍历获取数据。
  114. *
  115. * @return \PDOStatement
  116. */
  117. public function getStatement()
  118. {
  119. if (!$this->stmt) {
  120. throw new LogicException('SQL语句应该先被 QuickQuery.prepare 预处理');
  121. }
  123. return $this->stmt;
  124. }
  126. /**
  127. * getStatement 方法的替代名
  128. *
  129. * 实现 PHP 标准库 中的 IteratorAggregate 接口, 外部可以直接将本对象作为迭代器遍
  130. * 历。和 getStatment 唯一不同之处, 是本方法不会抛出 LogicException 异常。如果
  131. * 没有事先使用 prepare 和 execute, 会返回一个空迭代器。
  132. *
  133. * @return Traversable
  134. */
  135. public function getIterator()
  136. {
  137. try {
  138. return $this->getStatement();
  139. } catch (LogicException $ex) {
  140. return new \ArrayObject();
  141. }
  142. }
  144. /**
  145. * 设置查询参数检查
  146. *
  147. * 通过此处导入的被检查查询参数, 如果没有得到赋值, 则查询时会抛出 LogicException 异常。
  148. *
  149. * @param array $params
  150. * @return \Persistence\DbAccess\QuickQuery
  151. */
  152. public function setParamsCheck(array $params)
  153. {
  154. $this->checkedParams = $params;
  156. return $this;
  157. }
  159. /**
  160. * 将结果集转换为数组
  161. *
  162. * @return array
  163. */
  164. public function toArray()
  165. {
  166. return iterator_to_array($this->getStatement());
  167. }
  169. /**
  170. * 获取最后一个插入结果（或序列）的 ID
  171. *
  172. * @param string $name
  173. * @return int
  174. */
  175. public function getLastInsertId($name=null)
  176. {
  177. return $this->connection->getPDO()->lastInsertId($name);
  178. }
  179. }
  1. namespace Persistence\DbAccess;
  2. use InvalidArgumentException, BadMethodCallException;
  3. use PDO, PDOException;
  5. /**
  6. * 连接工厂，提供全局的PDO对象，并管理事务。
  7. *
  8. * @version 0.3
  9. * @author tonyseek
  10. * @link http://stu.szu.edu.cn
  11. * @license http://www.opensource.org/licenses/mit-license.html
  12. * @copyright StuCampus Development Team, Shenzhen University
  13. *
  14. */
  15. final class Connection
  16. {
  17. /**
  18. * Connector 实例集合
  19. *
  20. * @var array
  21. */
  22. static private $instances = array();
  24. /**
  25. * 数据库驱动名
  26. *
  27. * @var string
  28. */
  29. private $driver = '';
  31. /**
  32. * 数据库连接字符串(Database Source Name)
  33. *
  34. * @var string
  35. */
  36. private $dsn = '';
  38. /**
  39. * PDO 实例
  40. *
  41. * @var \PDO
  42. */
  43. private $pdo = null;
  45. /**
  46. * 用户名
  47. *
  48. * @var string
  49. */
  50. private $username = '';
  52. /**
  53. * 密码
  54. *
  55. * @var string
  56. */
  57. private $password = '';
  59. /**
  60. * 是否开启持久连接
  61. *
  62. * @var bool
  63. */
  64. private $isPersisten = false;
  66. /**
  67. * 是否开启仿真预编译
  68. *
  69. * @var bool
  70. */
  71. private $isEmulate = false;
  73. /**
  74. * 是否在事务中
  75. *
  76. * @var bool
  77. */
  78. private $isInTransation = false;
  80. /**
  81. * 私有构造函数，阻止外部使用 new 操作符实例化
  82. */
  83. private function __construct(){}
  85. /**
  86. * 生产 Connector 实例（多例）
  87. *
  88. * @param string $name
  89. * @return \StuCampus\DataModel\Connector
  90. */
  91. static public function getInstance($name = 'default')
  92. {
  93. if (!isset(self::$instances[$name])) {
  94. // 如果访问的实例不存在则抛出错误异常
  95. throw new InvalidArgumentException("[{$name}] 不存在");
  96. }
  98. return self::$instances[$name];
  99. }
  101. /**
  102. * 断开所有数据库实例的连接
  103. */
  104. static public function disconnectAll()
  105. {
  106. foreach (self::$instances as $instance) {
  107. $instance->disconnect();
  108. }
  109. }
  111. /**
  112. * 添加数据库
  113. *
  114. * 向实例群添加 Connector
  115. *
  116. * @param string $name 标识名
  117. * @param string $driver 驱动名
  118. * @param string $dsn 连接字符串
  119. * @param string $usr 数据库用户名
  120. * @param string $pwd 数据库密码
  121. * @param bool $emulate 仿真预编译查询
  122. * @param bool $persisten 是否持久连接
  123. */
  124. static public function registry($name, $driver, $dsn, $usr, $pwd, $emulate = false, $persisten = false)
  125. {
  126. if (isset(self::$instances[$name])) {
  127. // 如果添加的实例名已经存在则抛出异常
  128. throw new BadMethodCallException("[{$name}] 已被注册");
  129. }
  131. // 实例化自身，并推入数组中
  132. self::$instances[$name] = new self();
  133. self::$instances[$name]->dsn = $driver . ':' . $dsn;
  134. self::$instances[$name]->username = $usr;
  135. self::$instances[$name]->password = $pwd;
  136. self::$instances[$name]->driver = $driver;
  137. self::$instances[$name]->isPersisten = (bool)$persisten;
  138. self::$instances[$name]->isEmulate = (bool)$emulate;
  139. }
  141. /**
  142. * 获取 PHP Database Object
  143. *
  144. * @return \PDO
  145. */
  146. public function getPDO()
  147. {
  148. if (!$this->pdo) {
  149. // 检查 PDO 是否已经实例化，否则先实例化 PDO
  150. $this->pdo = new PDO($this->dsn, $this->username, $this->password);
  151. // 错误模式为抛出 PDOException 异常
  152. $this->pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
  153. // 开启查询缓存
  154. $this->pdo->setAttribute(PDO::ATTR_EMULATE_PREPARES, $this->isEmulate);
  155. // 开启持久连接
  156. $this->pdo->setAttribute(PDO::ATTR_PERSISTENT, $this->isPersisten);
  158. }
  160. return $this->pdo;
  161. }
  163. /**
  164. * 获取数据库驱动名
  165. *
  166. * @return string
  167. */
  168. public function getDriverName()
  169. {
  170. return $this->driver;
  171. }
  173. /**
  174. * 开始事务
  175. */
  176. public function transationBegin()
  177. {
  178. $this->isInTransation = $this->getPDO()->beginTransaction();
  179. }
  181. /**
  182. * 提交事务
  183. */
  184. public function transationCommit()
  185. {
  186. if ($this->isInTransation) {
  187. $this->getPDO()->commit();
  188. } else {
  189. trigger_error('transationBegin 应该先于 transationCommit 调用');
  190. }
  191. }
  193. /**
  194. * 回滚事务
  195. * @return bool
  196. */
  197. public function transationRollback()
  198. {
  199. if ($this->isInTransation) {
  200. $this->getPDO()->rollBack();
  201. } else {
  202. trigger_error('transationBegin 应该先于 transationRollback 调用');
  203. }
  204. }
  206. /**
  207. * 连接是否在事务中
  208. *
  209. * @return bool
  210. */
  211. public function isInTransation()
  212. {
  213. return $this->isInTransation;
  214. }
  216. /**
  217. * 在事务中执行回调函数
  218. *
  219. * @param function $callback 匿名函数或闭包函数
  220. * @param bool $autoRollback 异常发生时是否自动回滚
  221. * @throws \PDOException
  222. * @return bool
  223. */
  224. public function transationExecute($callback, $autoRollback = true)
  225. {
  226. try {
  227. // 开始事务
  228. $this->transationBegin();
  229. // 调用回调函数
  230. if (is_callable($callback)) {
  231. $callback();
  232. } else {
  233. throw new InvalidArgumentException('$callback应该为回调函数');
  234. }
  235. // 提交事务
  236. return $this->transationCommit();
  237. } catch(PDOException $pex) {
  238. // 如果开启了自动回滚, 则捕捉到 PDO 异常时先回滚再抛出
  239. if ($autoRollback) {
  240. $this->transationRollback();
  241. }
  242. throw $pex;
  243. }
  244. }
  246. /**
  247. * 安全地断开数据库连接
  248. */
  249. public function disconnect()
  250. {
  251. if ($this->pdo) {
  252. // 检查 PDO 是否已经实例化，是则设置为null
  253. $this->pdo = null;
  254. }
  255. }
  257. /**
  258. * 阻止克隆
  259. */
  260. public function __clone()
  261. {
  262. trigger_error('被阻止的 __clone 方法, Connector 是单例类');
  263. }
  264. }

人气教程排行

本站所有资源全部来源于网络，若本站发布的内容侵害到您的隐私或者利益，请联系我们删除！