PHP单例模式编写PDO抽象层类

attachment/2018/01/16/19501516118149.jpg

一 序

什么是单例模式

单例模式，是一种常用的程序设计模式。在它的核心结构中只包含一个被称为单例的特殊类。通过单例模式可以保证系统中，应用该模式的类只有一个实例。即一个类只有一个对象实例。

举个生活中的栗子： 几个班的同学要一起去上计算机课，但是学校只有一个计算机教室，所以这几个班的同学就必须得想办法共用一个教室，这就类似于程序中的单例模式

什么是PDO

PHP 数据对象（PDO）扩展为PHP访问数据库定义了一个轻量级的一致接口。实现 PDO 接口的每个数据库驱动可以公开具体数据库的特性作为标准扩展功能。注意利用 PDO 扩展自身并不能实现任何数据库功能；必须使用一个具体数据库的 PDO 驱动来访问数据库服务。

PDO 提供了一个数据访问抽象层，这意味着，不管使用哪种数据库，都可以用相同的函数（方法）来查询和获取数据。 PDO 不提供数据库抽象层；它不会重写 SQL，也不会模拟缺失的特性。如果需要的话，应该使用一个成熟的抽象层。

从 PHP 5.1 开始附带了 PDO，在 PHP 5.0 中是作为一个 PECL 扩展使用。 PDO 需要PHP 5 核心的新 OO 特性，因此不能在较早版本的 PHP 上运行。

为什么要使用单例模式编写PDO类

php的应用主要在于数据库应用, 所以一个应用中会存在大量的数据库操作, 使用单例模式, 则可以避免大量的new 操作消耗的资源。

如果系统中需要有一个类来全局控制某些配置信息, 那么使用单例模式可以很方便的实现

在一次页面请求中, 便于进行调试, 因为所有的代码(例如数据库操作类db)都集中在一个类中, 我们可以在类中设置钩子, 输出日志，从而避免到处var_dump, echo。

二 初识PDO

Linux开启PDO扩展

1	`extension=pdo.so`

Windows开启PDO扩展

1	`extension=php_pdo.dll`

开启PDO对MySQL的扩展

1	`extension=php_pdo_mssql.dll`

使用PDO简单连接MySQL

<?php 
$dbms = 'mysql';     //数据库类型 
$host = '127.0.0.1'; //数据库主机名 
$dbName = 'blog';    //使用的数据库 
$user = 'root';      //数据库连接用户名 默认为root 
$pass = 'root';          //数据库密码 默认为root 
$dsn="$dbms:host=$host;dbname=$dbName"; 
 
try { 
    $dbh = new PDO($dsn, $user, $pass); //初始化一个PDO对象 
    echo "连接成功<br/>";   //output: '连接成功' 
    /*你还可以进行一次搜索操作 
    foreach ($dbh->query('SELECT * from FOO') as $row) { 
        print_r($row); //你可以用 echo($GLOBAL); 来看到这些值 
    } 
    */ 
    $dbh = null; 
} catch (PDOException $e) { 
    die ("Error!: " . $e->getMessage() . "<br/>"); 
} 
//默认这个不是长连接，如果需要数据库长连接，需要最后加一个参数：array(PDO::ATTR_PERSISTENT => true) 
$db = new PDO($dsn, $user, $pass, array(PDO::ATTR_PERSISTENT => true)); 

三 使用单例模式进行封装PDO类

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

<?php
/**
 * class MyPDO
 * @author Leo <775126470@qq.com>
 * @site http://www.lcgod.com/
 * @version 5.0 utf8
 */
class MyPDO
{
    protected static $_instance = null;
    protected $dbName = '';
    protected $dsn;
    protected $dbh;
 
    /**
     * MyPDO constructor.
     * @param $dbHost
     * @param $dbUser
     * @param $dbPasswd
     * @param $dbName
     * @param $dbCharset
     * @throws Exception
     */
    private function __construct($dbHost, $dbUser, $dbPasswd, $dbName, $dbCharset)
    {
        try {
            $this->dsn = 'mysql:host=' . $dbHost. ';dbname=' . $dbName;
            $this->dbh = new PDO($this->dsn, $dbUser, $dbPasswd);
            $sql = 'set character_set_connection=' . $dbCharset . ', character_set_results=' . $dbCharset;
            $sql .= ', character_set_client=binary';
            $this->dbh->exec($sql);
        } catch (PDOException $e) {
            $this->outputError($e->getMessage());
        }
    }
 
    /**
     * 防止克隆
     *
     */
    private function __clone() {}
 
    /**
     * @param $dbHost
     * @param $dbUser
     * @param $dbPasswd
     * @param $dbName
     * @param $dbCharset
     * @return MyPDO|null
     */
    public static function getInstance($dbHost, $dbUser, $dbPasswd, $dbName, $dbCharset)
    {
        if (self::$_instance === null) {
            self::$_instance = new self($dbHost, $dbUser, $dbPasswd, $dbName, $dbCharset);
        }
        return self::$_instance;
    }
 
    /**
     * Query查询
     * @param $strSql
     * @param string $queryMode
     * @param bool $debug
     * @return array|mixed|null
     */
    public function query($strSql, $queryMode = 'All', $debug = false)
    {
        if ($debug === true) $this->debug($strSql);
        $recordset = $this->dbh->query($strSql);
        $this->getPDOError();
        if ($recordset) {
            $recordset->setFetchMode(PDO::FETCH_ASSOC);
            if ($queryMode == 'All') {
                $result = $recordset->fetchAll();
            } elseif ($queryMode == 'Row') {
                $result = $recordset->fetch();
            }
        } else {
            $result = null;
        }
        return $result;
    }
 
    /**
     * update 更新
     * @param $table
     * @param $arrayDataValue
     * @param string $where
     * @param bool $debug
     * @return int
     * @throws Exception
     */
    public function update($table, $arrayDataValue, $where = '', $debug = false)
    {
        $this->checkFields($table, $arrayDataValue);
        if ($where) {
            $strSql = '';
            foreach ($arrayDataValue as $key => $value) {
                $strSql .= ", '$key'='$value'";
            }
            $strSql = substr($strSql, 1);
            $strSql = 'update ' . $table . ' set ' . $strSql . ' where ' . $where;
        } else {
            $strSql = 'replace into ' . $table;
            $strSql .= "('" . implode('', array_keys($arrayDataValue) ) . "') values ('";
            $strSql .= implode("','", $arrayDataValue) . "')";
        }
        if ($debug === true) $this->debug($strSql);
        $result = $this->dbh->exec($strSql);
        $this->getPDOError();
        return $result;
    }
 
    /**
     * Insert 插入
     * @param $table
     * @param $arrayDataValue
     * @param bool $debug
     * @return int
     * @throws Exception
     */
    public function insert($table, $arrayDataValue, $debug = false)
    {
        $this->checkFields($table, $arrayDataValue);
        $strSql = 'insert into ' . $table;
        $strSql .= "('" . implode('', array_keys($arrayDataValue)) . "') values ('";
        $strSql .= implode("','", $arrayDataValue) . "')";
        if ($debug === true) $this->debug($strSql);
        $result = $this->dbh->exec($strSql);
        $this->getPDOError();
        return $result;
    }
 
    /**
     * Replace 替换
     * @param $table
     * @param $arrayDataValue
     * @param bool $debug
     * @return int
     * @throws Exception
     */
    public function replace($table, $arrayDataValue, $debug = false)
    {
        $this->checkFields($table, $arrayDataValue);
        $strSql = 'replace into ' . $table;
        $strSql .= "'('" . implode('', array_keys($arrayDataValue)) . "') values ('";
        $strSql .= implode("','", $arrayDataValue) . "')";
        if ($debug === true) $this->debug($strSql);
        $result = $this->dbh->exec($strSql);
        $this->getPDOError();
        return $result;
    }
 
    /**
     * Delete 删除记录
     * @param $table
     * @param string $where
     * @param bool $debug
     * @return int
     * @throws Exception
     */
    public function delete($table, $where = '', $debug = false)
    {
        if ($where == '') {
            $this->outputError("'WHERE' is Null");
        } else {
            $strSql = "delete from '$table' where $where";
            if ($debug === true) $this->debug($strSql);
            $result = $this->dbh->exec($strSql);
            $this->getPDOError();
            return $result;
        }
    }
 
    /**
     * execSql 执行SQL语句
     *
     * @param String $strSql
     * @param Boolean $debug
     * @return Int
     */
    public function execSql($strSql, $debug = false)
    {
        if ($debug === true) $this->debug($strSql);
        $result = $this->dbh->exec($strSql);
        $this->getPDOError();
        return $result;
    }
 
    /**
     * getMaxValue 获取字段最大值
     *
     * @param $table
     * @param $field_name
     * @param string $where
     * @param bool $debug
     * @return int|mixed
     */
    public function getMaxValue($table, $field_name, $where = '', $debug = false)
    {
        $strSql = "select max(".$field_name.") as max_value from $table";
        if ($where != '') $strSql .= " where $where";
        if ($debug === true) $this->debug($strSql);
        $arrTemp = $this->query($strSql, 'Row');
        $maxValue = $arrTemp['max_value'];
        if ($maxValue == "" || $maxValue == null) {
            $maxValue = 0;
        }
        return $maxValue;
    }
 
    /**
     * 获取指定列的数量
     *
     * @param string $table
     * @param string $field_name
     * @param string $where
     * @param bool $debug
     * @return int
     */
    public function getCount($table, $field_name, $where = '', $debug = false)
    {
        $strSql = "select count($field_name) as num from $table";
        if ($where != '') $strSql .= " where $where";
        if ($debug === true) $this->debug($strSql);
        $arrTemp = $this->query($strSql, 'Row');
        return $arrTemp['num'];
    }
 
    /**
     * 获取表引擎
     *
     * @param $dbName
     * @param $tableName
     * @return mixed
     */
    public function getTableEngine($dbName, $tableName)
    {
        $strSql = "show table status from $dbName where name='".$tableName."'";
        $arrayTableInfo = $this->query($strSql);
        $this->getPDOError();
        return $arrayTableInfo[0]['Engine'];
    }
 
    /**
     * beginTransaction 事务开始
     */
    private function beginTransaction()
    {
        $this->dbh->beginTransaction();
    }
 
    /**
     * commit 事务提交
     */
    private function commit()
    {
        $this->dbh->commit();
    }
 
    /**
     * rollback 事务回滚
     */
    private function rollback()
    {
        $this->dbh->rollback();
    }
 
    /**
     * transaction 通过事务处理多条SQL语句
     * 调用前需通过getTableEngine判断表引擎是否支持事务
     *
     * @param array $arraySql
     * @return Boolean
     */
    public function execTransaction($arraySql)
    {
        $retval = 1;
        $this->beginTransaction();
        foreach ($arraySql as $strSql) {
            if ($this->execSql($strSql) == 0) $retval = 0;
        }
        if ($retval == 0) {
            $this->rollback();
            return false;
        } else {
            $this->commit();
            return true;
        }
    }
 
    /**
     * 检查指定字段是否在指定数据表中存在
     * @param $table [数据表]
     * @param $arrayFields []
     * @throws Exception
     */
    private function checkFields($table, $arrayFields)
    {
        $fields = $this->getFields($table);
        foreach ($arrayFields as $key => $value) {
            if (!in_array($key, $fields)) {
                $this->outputError('Unknown column' .  $key . 'in field list.');
            }
        }
    }
 
    /**
     * getFields 获取指定数据表中的全部字段名
     *
     * @param String $table 表名
     * @return array
     */
    private function getFields($table)
    {
        $fields = array();
        $recordset = $this->dbh->query("show columns from $table");
        $this->getPDOError();
        $recordset->setFetchMode(PDO::FETCH_ASSOC);
        $result = $recordset->fetchAll();
        foreach ($result as $rows) {
            $fields[] = $rows['Field'];
        }
        return $fields;
    }
 
    /**
     * getPDOError 捕获PDO错误信息
     */
    private function getPDOError()
    {
        if ($this->dbh->errorCode() != '00000') {
            $arrayError = $this->dbh->errorInfo();
            $this->outputError( $arrayError[2] );
        }
    }
 
    /**
     * debug
     *
     * @param mixed $debuginfo
     */
    private function debug( $debuginfo ){
        var_dump($debuginfo);die;
    }
 
    /**
     * @param $strErrMsg [错误语句]
     * @throws Exception [抛出异常]
     */
    private function outputError( $strErrMsg ){
        throw new Exception('MySQL Error: '.$strErrMsg);
    }
 
    /**
     * destruct 关闭数据库连接
     */
    public function destruct(){
        $this->dbh = null;
    }
}

调用方式

<?php
require_once 'MyPDO.php';
 
$db = MyPDO::getInstance('localhost', 'root', 'root', 'blog', 'gbk');
 
//do something...
 
$db->destruct();