项目规划

为什么需要项目规划？

在开始编写代码之前，良好的项目规划是成功的关键。项目规划不仅能帮助我们理清思路，还能避免开发过程中的混乱和返工。

项目规划的好处

1. 明确目标：清楚地知道要实现什么功能
2. 合理分配资源：预估时间，合理安排开发进度
3. 降低风险：提前识别可能的问题和挑战
4. 提高效率：避免重复工作和方向错误
5. 便于协作：如果是团队项目，规划是协作的基础

需求分析

1. 需求收集

从用户角度思考

• 用户是谁？
• 用户需要什么功能？
• 用户如何使用系统？
• 用户会遇到什么问题？

业务需求示例

以用户注册登录系统为例：

基本需求：

• 用户可以通过邮箱注册
• 用户可以使用邮箱和密码登录
• 用户可以重置忘记的密码
• 用户可以查看和修改个人信息

扩展需求：

• 支持手机号注册
• 支持第三方登录（微信、QQ等）
• 用户权限管理（普通用户、管理员）
• 登录记录和安全日志

2. 功能列表

创建详细的功能清单，将需求转化为具体的开发任务：

# 用户注册登录系统功能清单

## 核心功能
- [ ] 用户注册
  - [ ] 邮箱验证
  - [ ] 密码强度检查
  - [ ] 防机器人验证
- [ ] 用户登录
  - [ ] 记住登录状态
  - [ ] 登录失败锁定
  - [ ] 登录日志记录
- [ ] 密码重置
  - [ ] 邮件验证码
  - [ ] 安全链接
  - [ ] 一次性使用

## 用户管理
- [ ] 个人资料查看
- [ ] 个人资料修改
- [ ] 密码修改
- [ ] 账户注销
- [ ] 权限管理

## 安全功能
- [ ] SQL注入防护
- [ ] XSS攻击防护
- [ ] CSRF防护
- [ ] 会话安全

技术选型

1. 选择合适的技术栈

根据项目需求选择技术：

后端技术

• PHP版本：PHP 7.4+（推荐PHP 8.0+）
• Web服务器：Apache 或 Nginx
• 数据库：MySQL 5.7+ 或 MariaDB 10.2+

开发框架选择

// 原生PHP - 适合学习
// 优点：深入了解PHP工作原理
// 缺点：开发效率较低，需要处理大量细节

// 轻量级框架 - 适合小型项目
// 例如：Slim, CodeIgniter
// 优点：开发效率高，学习曲线平缓

// 全功能框架 - 适合大型项目
// 例如：Laravel, Symfony
// 优点：功能完善，生态系统好

2. 项目架构设计

MVC架构模式

Model（模型）      View（视图）       Controller（控制器）
     |                 |                     |
数据处理         用户界面          业务逻辑控制
     |                 |                     |
数据库操作         HTML/CSS         接收请求、响应
     |                 |                     |

目录结构设计

auth-system/
├── public/                 # Web根目录
│   ├── index.php         # 入口文件
│   ├── css/              # 样式文件
│   ├── js/               # JavaScript文件
│   └── images/           # 图片资源
├── src/                   # 源代码目录
│   ├── controllers/      # 控制器
│   │   ├── AuthController.php
│   │   ├── UserController.php
│   │   └── BaseController.php
│   ├── models/           # 模型
│   │   ├── User.php
│   │   ├── Auth.php
│   │   └── Database.php
│   ├── views/            # 视图
│   │   ├── auth/
│   │   │   ├── login.php
│   │   │   ├── register.php
│   │   │   └── reset.php
│   │   └── user/
│   │       ├── profile.php
│   │       └── edit.php
│   ├── helpers/          # 辅助类
│   │   ├── Validator.php
│   │   ├── Mailer.php
│   │   └── Session.php
│   └── config/           # 配置文件
│       ├── database.php
│       ├── app.php
│       └── email.php
├── uploads/              # 上传文件
├── logs/                 # 日志文件
├── vendor/               # 第三方库（Composer）
├── database/             # 数据库相关
│   ├── migrations/       # 数据库迁移
│   └── seeds/            # 测试数据
├── docs/                 # 项目文档
├── tests/                # 测试文件
├── .gitignore
├── composer.json
└── README.md

数据库设计

1. 设计数据库表结构

用户表（users）

CREATE TABLE users (
    id INT PRIMARY KEY AUTO_INCREMENT,
    username VARCHAR(50) UNIQUE NOT NULL,
    email VARCHAR(100) UNIQUE NOT NULL,
    password_hash VARCHAR(255) NOT NULL,
    email_verified BOOLEAN DEFAULT FALSE,
    email_verification_token VARCHAR(255),
    status ENUM('active', 'inactive', 'suspended') DEFAULT 'inactive',
    role ENUM('user', 'admin') DEFAULT 'user',
    created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
    updated_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
    last_login_at TIMESTAMP NULL
);

用户资料表（user_profiles）

CREATE TABLE user_profiles (
    user_id INT PRIMARY KEY,
    first_name VARCHAR(50),
    last_name VARCHAR(50),
    phone VARCHAR(20),
    avatar VARCHAR(255),
    bio TEXT,
    birth_date DATE,
    created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
    updated_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
    FOREIGN KEY (user_id) REFERENCES users(id) ON DELETE CASCADE
);

密码重置表（password_resets）

CREATE TABLE password_resets (
    id INT PRIMARY KEY AUTO_INCREMENT,
    user_id INT NOT NULL,
    token VARCHAR(255) NOT NULL,
    expires_at TIMESTAMP NOT NULL,
    used BOOLEAN DEFAULT FALSE,
    created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
    FOREIGN KEY (user_id) REFERENCES users(id) ON DELETE CASCADE
);

登录日志表（login_logs）

CREATE TABLE login_logs (
    id INT PRIMARY KEY AUTO_INCREMENT,
    user_id INT,
    ip_address VARCHAR(45) NOT NULL,
    user_agent TEXT,
    success BOOLEAN NOT NULL,
    created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
    FOREIGN KEY (user_id) REFERENCES users(id) ON DELETE SET NULL
);

2. 数据库关系图

users (用户表)
    ├── has_one ─── user_profiles (用户资料)
    ├── has_many ─── password_resets (密码重置)
    └── has_many ─── login_logs (登录日志)

开发计划

1. 制定开发时间表

使用甘特图或简单的表格来规划开发进度：

2. 迭代开发策略

第一迭代（MVP - 最小可行产品）

• 用户注册（基本功能）
• 用户登录
• 基本的会话管理

第二迭代（核心功能）

• 邮箱验证
• 密码重置
• 用户资料管理

第三迭代（增强功能）

• 权限管理
• 安全日志
• 管理后台

开发环境搭建

1. 本地开发环境

使用XAMPP（Windows）

1. 下载并安装XAMPP
2. 启动Apache和MySQL
3. 创建项目目录：C:/xampp/htdocs/auth-system/
4. 配置虚拟主机（可选）

使用Docker（跨平台）

# Dockerfile
FROM php:8.0-apache

# 安装必要扩展
RUN docker-php-ext-install pdo_mysql mysqli

# 启用Apache模块
RUN a2enmod rewrite

# 设置工作目录
WORKDIR /var/www/html

# 复制项目文件
COPY . /var/www/html/

# 设置权限
RUN chown -R www-data:www-data /var/www/html

EXPOSE 80

2. 开发工具配置

VS Code配置

{
    "php.validate.executablePath": "/usr/bin/php",
    "php.debug.executablePath": "/usr/bin/php",
    "files.associations": {
        "*.php": "php"
    },
    "emmet.includeLanguages": {
        "php": "html"
    }
}

代码规范

1. PSR编码标准

遵循PSR-1和PSR-12编码规范：

<?php
namespace App\Controllers;

use App\Models\User;
use App\Helpers\Validator;

class AuthController
{
    private $user;
    private $validator;

    public function __construct()
    {
        $this->user = new User();
        $this->validator = new Validator();
    }

    /**
     * 处理用户注册
     *
     * @param array $data 注册数据
     * @return array 注册结果
     */
    public function register(array $data): array
    {
        // 验证数据
        if (!$this->validator->validate($data)) {
            return [
                'success' => false,
                'message' => '数据验证失败'
            ];
        }

        // 创建用户
        $userId = $this->user->create($data);

        if ($userId) {
            return [
                'success' => true,
                'user_id' => $userId,
                'message' => '注册成功'
            ];
        }

        return [
            'success' => false,
            'message' => '注册失败'
        ];
    }
}

2. 命名规范

• 类名：使用大驼峰命名法（PascalCase）
• 方法名：使用小驼峰命名法（camelCase）
• 变量名：使用小驼峰命名法（camelCase）
• 常量名：使用大写下划线命名（UPPER_SNAKE_CASE）

测试策略

1. 单元测试

<?php
use PHPUnit\Framework\TestCase;

class AuthControllerTest extends TestCase
{
    private $authController;

    protected function setUp(): void
    {
        $this->authController = new AuthController();
    }

    public function testRegisterSuccess()
    {
        $data = [
            'username' => 'testuser',
            'email' => 'test@example.com',
            'password' => 'password123'
        ];

        $result = $this->authController->register($data);

        $this->assertTrue($result['success']);
        $this->assertArrayHasKey('user_id', $result);
    }

    public function testRegisterWithInvalidEmail()
    {
        $data = [
            'username' => 'testuser',
            'email' => 'invalid-email',
            'password' => 'password123'
        ];

        $result = $this->authController->register($data);

        $this->assertFalse($result['success']);
    }
}

2. 集成测试

<?php
class AuthIntegrationTest extends TestCase
{
    public function testCompleteRegistrationFlow()
    {
        // 1. 用户注册
        $registerData = [
            'username' => 'newuser',
            'email' => 'newuser@example.com',
            'password' => 'securepassword'
        ];

        $registerResult = $this->post('/register', $registerData);
        $this->assertEquals(200, $registerResult->getStatusCode());

        // 2. 用户登录
        $loginData = [
            'email' => 'newuser@example.com',
            'password' => 'securepassword'
        ];

        $loginResult = $this->post('/login', $loginData);
        $this->assertEquals(200, $loginResult->getStatusCode());
        $this->assertArrayHasKey('token', json_decode($loginResult->getContent(), true));
    }
}

风险评估

1. 技术风险

2. 进度风险

文档编写

1. 技术文档

README.md

# 用户注册登录系统

## 项目简介
一个安全、可靠的用户认证系统。

## 功能特性
- 用户注册和登录
- 邮箱验证
- 密码重置
- 用户权限管理

## 技术栈
- PHP 8.0
- MySQL 8.0
- Bootstrap 5
- jQuery 3.6

## 安装部署
详见 [部署文档](docs/deployment.md)

## API文档
详见 [API文档](docs/api.md)

API文档

# API文档

## 用户注册
POST /api/register

### 请求参数
```json
{
    "username": "string",
    "email": "string",
    "password": "string",
    "confirm_password": "string"
}

响应

{
    "success": true,
    "message": "注册成功",
    "user_id": 123
}

### 2. 用户文档

#### 用户手册
- 注册流程说明
- 功能使用指南
- 常见问题解答
- 联系方式

## 部署规划

### 1. 生产环境准备

#### 服务器配置要求

最低配置：

• CPU: 1核心
• 内存: 1GB
• 存储: 20GB SSD
• 带宽: 5Mbps

推荐配置：

• CPU: 2核心
• 内存: 2GB
• 存储: 50GB SSD
• 带宽: 10Mbps

### 2. 部署检查清单

```markdown
## 部署前检查
- [ ] 代码审查完成
- [ ] 测试通过
- [ ] 安全检查完成
- [ ] 文档更新

## 部署后检查
- [ ] 功能测试
- [ ] 性能测试
- [ ] 安全扫描
- [ ] 备份设置

项目管理工具

1. 版本控制

# Git工作流程
git clone <repository>
git checkout -b feature/user-registration
# 开发功能
git add .
git commit -m "feat: 添加用户注册功能"
git push origin feature/user-registration
# 创建Pull Request

2. 项目跟踪

使用Trello或简单的表格跟踪进度：

总结

良好的项目规划是成功的基础。通过本章的学习，你应该掌握了：

1. 如何进行需求分析和功能设计
2. 如何选择合适的技术栈和架构
3. 如何设计数据库结构
4. 如何制定合理的开发计划
5. 如何进行风险评估和应对

记住，规划不是一成不变的。在开发过程中，要根据实际情况灵活调整，但始终保持对目标的清晰认识。

下一步，让我们开始实际开发第一个项目——用户注册登录系统！