PHPackages                             xiaououo/xuophp - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Framework](/categories/framework)
4. /
5. xiaououo/xuophp

ActiveProject[Framework](/categories/framework)

xiaououo/xuophp
===============

XiaoPHP 1.4 - 轻量级PHP开发框架

v1.4.0(3d ago)03MITPHP ^7.2 || ^8.0

Since Jul 7Compare

[ Source](https://github.com/xiaououo/XuoPHP)[ Packagist](https://packagist.org/packages/xiaououo/xuophp)[ RSS](/packages/xiaououo-xuophp/feed)WikiDiscussions Synced today

READMEChangelog (1)DependenciesVersions (2)Used By (0)

小新PHP (XiaoPHP) v1.4.0 使用文档
===========================

[](#小新php-xiaophp-v140-使用文档)

> **作者**：是小新呀
> **版本**：1.4.0
> **简介**：基于 PHP 的轻量级 MVC 框架，适合小型项目快速开发

---

目录
--

[](#目录)

- [一、环境要求](#%E4%B8%80%E7%8E%AF%E5%A2%83%E8%A6%81%E6%B1%82)
- [二、项目部署](#%E4%BA%8C%E9%A1%B9%E7%9B%AE%E9%83%A8%E7%BD%B2)
    - [2.1 Apache 部署](#21-apache-%E9%83%A8%E7%BD%B2)
    - [2.2 Nginx 部署](#22-nginx-%E9%83%A8%E7%BD%B2)
    - [2.3 PHP 内置服务器](#23-php-%E5%86%85%E7%BD%AE%E6%9C%8D%E5%8A%A1%E5%99%A8)
- [三、目录结构](#%E4%B8%89%E7%9B%AE%E5%BD%95%E7%BB%93%E6%9E%84)
- [四、配置说明](#%E5%9B%9B%E9%85%8D%E7%BD%AE%E8%AF%B4%E6%98%8E)
    - [4.1 主配置文件](#41-%E4%B8%BB%E9%85%8D%E7%BD%AE%E6%96%87%E4%BB%B6)
    - [4.2 环境变量配置](#42-%E7%8E%AF%E5%A2%83%E5%8F%98%E9%87%8F%E9%85%8D%E7%BD%AE)
    - [4.3 日志配置](#43-%E6%97%A5%E5%BF%97%E9%85%8D%E7%BD%AE)
    - [4.4 Cookie 配置](#44-cookie-%E9%85%8D%E7%BD%AE)
    - [4.5 阿里云 DNS 配置](#45-%E9%98%BF%E9%87%8C%E4%BA%91-dns-%E9%85%8D%E7%BD%AE)
- [五、路由与控制器](#%E4%BA%94%E8%B7%AF%E7%94%B1%E4%B8%8E%E6%8E%A7%E5%88%B6%E5%99%A8)
    - [5.1 路由规则](#51-%E8%B7%AF%E7%94%B1%E8%A7%84%E5%88%99)
    - [5.2 创建控制器](#52-%E5%88%9B%E5%BB%BA%E6%8E%A7%E5%88%B6%E5%99%A8)
    - [5.3 默认控制器](#53-%E9%BB%98%E8%AE%A4%E6%8E%A7%E5%88%B6%E5%99%A8)
- [六、视图引擎](#%E5%85%AD%E8%A7%86%E5%9B%BE%E5%BC%95%E6%93%8E)
    - [6.1 模板语法](#61-%E6%A8%A1%E6%9D%BF%E8%AF%AD%E6%B3%95)
    - [6.2 基本用法](#62-%E5%9F%BA%E6%9C%AC%E7%94%A8%E6%B3%95)
    - [6.3 子目录模板](#63-%E5%AD%90%E7%9B%AE%E5%BD%95%E6%A8%A1%E6%9D%BF)
- [七、数据库操作](#%E4%B8%83%E6%95%B0%E6%8D%AE%E5%BA%93%E6%93%8D%E4%BD%9C)
    - [7.1 连接配置](#71-%E8%BF%9E%E6%8E%A5%E9%85%8D%E7%BD%AE)
    - [7.2 查询构造器](#72-%E6%9F%A5%E8%AF%A2%E6%9E%84%E9%80%A0%E5%99%A8)
    - [7.3 查询方法详解](#73-%E6%9F%A5%E8%AF%A2%E6%96%B9%E6%B3%95%E8%AF%A6%E8%A7%A3)
    - [7.4 辅助函数](#74-%E8%BE%85%E5%8A%A9%E5%87%BD%E6%95%B0)
- [八、Redis 缓存](#%E5%85%ABredis-%E7%BC%93%E5%AD%98)
    - [8.1 连接配置](#81-%E8%BF%9E%E6%8E%A5%E9%85%8D%E7%BD%AE)
    - [8.2 基本使用](#82-%E5%9F%BA%E6%9C%AC%E4%BD%BF%E7%94%A8)
    - [8.3 Pipeline 批量操作](#83-pipeline-%E6%89%B9%E9%87%8F%E6%93%8D%E4%BD%9C)
- [九、加密工具](#%E4%B9%9D%E5%8A%A0%E5%AF%86%E5%B7%A5%E5%85%B7)
    - [9.1 AES 加密](#91-aes-%E5%8A%A0%E5%AF%86)
    - [9.2 RSA 加密](#92-rsa-%E5%8A%A0%E5%AF%86)
- [十、阿里云 DNS 管理](#%E5%8D%81%E9%98%BF%E9%87%8C%E4%BA%91-dns-%E7%AE%A1%E7%90%86)
    - [10.1 配置 AccessKey](#101-%E9%85%8D%E7%BD%AE-accesskey)
    - [10.2 API 方法](#102-api-%E6%96%B9%E6%B3%95)
- [十一、HTTP 请求工具](#%E5%8D%81%E4%B8%80http-%E8%AF%B7%E6%B1%82%E5%B7%A5%E5%85%B7)
- [十二、调试模式](#%E5%8D%81%E4%BA%8C%E8%B0%83%E8%AF%95%E6%A8%A1%E5%BC%8F)
- [十三、错误处理](#%E5%8D%81%E4%B8%89%E9%94%99%E8%AF%AF%E5%A4%84%E7%90%86)
- [十四、请求日志](#%E5%8D%81%E5%9B%9B%E8%AF%B7%E6%B1%82%E6%97%A5%E5%BF%97)
- [十五、自定义函数](#%E5%8D%81%E4%BA%94%E8%87%AA%E5%AE%9A%E4%B9%89%E5%87%BD%E6%95%B0)
- [十六、注意事项](#%E5%8D%81%E5%85%AD%E6%B3%A8%E6%84%8F%E4%BA%8B%E9%A1%B9)

---

一、环境要求
------

[](#一环境要求)

组件要求PHP>= 7.4扩展`openssl`、`curl`、`pdo_mysql`、`json`可选扩展`redis`（用于 Redis 功能）Composer可选（用于加载第三方依赖）---

二、项目部署
------

[](#二项目部署)

将项目放置到 Web 服务器的根目录，**入口目录为 `public/`**。

### 2.1 Apache 部署

[](#21-apache-部署)

确保 Apache 开启 `mod_rewrite` 模块，在 `public/` 目录下创建 `.htaccess` 文件：

```
RewriteEngine On
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
RewriteRule ^(.*)$ index.php/$1 [QSA,PT,L]
```

### 2.2 Nginx 部署

[](#22-nginx-部署)

在 Nginx 配置文件中添加以下规则（已内置在 `public/nginx.htaccess` 中）：

```
location / {
    try_files $uri $uri/ /index.php?$args;
}
```

### 2.3 PHP 内置服务器

[](#23-php-内置服务器)

开发时可直接使用 PHP 内置服务器，项目已自带 `router.php` 处理静态资源：

```
cd public
php -S localhost:8000 router.php
```

---

三、目录结构
------

[](#三目录结构)

```
XiaoPHP1.4/
├── app/                    # 控制器目录，存放所有控制器文件
├── config/                 # 业务配置文件目录
│   ├── aliyundns.php       # 阿里云 DNS 配置
│   ├── cookie.php          # Cookie 配置
│   └── logs.php            # 日志开关配置
├── func/                   # 自定义函数目录（.php 文件会自动加载）
├── logs/                   # 日志存储目录
│   ├── error/              # 失败请求日志
│   └── success/            # 成功请求日志
├── public/                 # Web 入口目录（网站根目录）
│   ├── index.php           # 入口文件
│   ├── router.php          # PHP 内置服务器路由
│   └── nginx.htaccess      # Nginx 伪静态参考
├── temp/                   # 临时文件目录
│   ├── c_session/          # Cookie 存储的 Session 文件
│   └── s_cookie/           # cURL Cookie 持久化文件
├── view/                   # 视图模板目录
│   └── index/
│       └── index.html      # 默认首页模板
├── xuophp/                 # 框架核心目录
│   ├── Error/              # 错误处理
│   │   ├── 404.html        # 404 错误页面模板
│   │   └── error.php       # 错误处理函数
│   ├── tools/              # 系统工具
│   │   ├── systools.php    # 基础工具类
│   │   └── app/            # 应用工具类
│   │       ├── AesTools.php
│   │       ├── AliyunDns.php
│   │       ├── MysqlTools.php
│   │       ├── RedisTools.php
│   │       ├── RSATools.php
│   │       └── view.php
│   ├── conf.php            # 框架默认配置
│   ├── console.php         # 框架引导文件
│   ├── debug.php           # 调试信息展示
│   └── routing.php         # 路由分发
└── config.php              # 用户主配置文件

```

---

四、配置说明
------

[](#四配置说明)

### 4.1 主配置文件

[](#41-主配置文件)

编辑项目根目录下的 config.php：

```