import{_ as s,o as n,c as e,a2 as p}from"./chunks/framework.BbmSSMjL.js";const u=JSON.parse('{"title":"3.1 概述与目标","description":"","frontmatter":{},"headers":[],"relativePath":"zh/guide/overview.md","filePath":"zh/guide/overview.md"}'),l={name:"zh/guide/overview.md"};function t(d,a,i,o,c,r){return n(),e("div",null,[...a[0]||(a[0]=[p(`

3.1 概述与目标 ​

概述

本章以项目内置的 example(案例演示) 模块为例,从数据库建表到前端页面联调,手把手演示开发全流程。学完本章后,您将掌握新增业务模块的标准步骤。

开发流程总览 ​

text
┌──────────┐
│ 1. 建表   │  创建数据库表(含公共字段)
└────┬─────┘
     │
     ▼
┌──────────┐
│ 2. Model  │  创建数据模型(模型 Trait 复用)
└────┬─────┘
     │
     ▼
┌──────────┐
│ 3. FormRequest │ 创建表单请求验证(BaseRequest)
└────┬─────┘
     │
     ▼
┌──────────┐
│ 4. Service│  创建业务服务(属性配置 + 钩子)
└────┬─────┘
     │
     ▼
┌──────────┐
│ 5. Controller│ 创建控制器(注解 + 快捷方法)
└────┬─────┘
     │
     ▼
┌──────────┐
│ 6. Route  │  注册路由(routes/api.php)
└────┬─────┘
     │
     ▼
┌──────────┐
│ 7. Menu   │  配置菜单权限(可选)
└────┬─────┘
     │
     ▼
┌──────────┐
│ 8. Frontend│ 前端 API + 页面([详见第 9 章](/zh/frontend/overview.html))
└──────────┘

开发约定 ​

约定说明示例
表名不含前缀,前缀由 DB_PREFIX 决定(默认 laravel_)example → 实际 laravel_example
字段名小写下划线create_time、user_id
主键统一使用 id,INT 自增id INT PRIMARY KEY AUTO_INCREMENT
Model位于 app/Models/,$table 指定表名protected $table = 'example'
Service继承 BaseService 或 BaseTenantServiceclass ExampleService extends BaseService
Request继承 BaseRequest,rules() 声明规则class ExampleRequest extends BaseRequest
Controller位于 app/Http/Controllers/Api/,继承 Controllerclass ExampleController extends Controller
权限码sys:模块名:操作sys:example:add
路由routes/api.php,RESTful 风格GET /api/example/page

本章示例 ​

本章以项目内置的 example(案例演示) 模块为例,完整演示从建表到联调的全过程。该模块是代码生成器的参考模板,涵盖了标准 CRUD 的所有典型场景:

涉及文件 ​

text
app/Models/Example.php                    # 数据模型
app/Http/Requests/ExampleRequest.php      # 表单请求验证
app/Services/ExampleService.php           # 业务服务
app/Http/Controllers/Api/ExampleController.php  # 控制器
routes/api.php                            # 路由(example 模块 9 条)
# 前端(本仓库 ui/ 目录):
# ui/src/api/tool/example.ts              # 前端 API 模块
# ui/src/views/tool/example/              # 前端页面

学习建议 ​

  1. 先通读 3.2~3.8 按顺序跟随 example 模块走一遍;
  2. 重点理解 声明式配置:Service 只声明属性,CRUD 由 BaseService + 6 个 Trait 完成;
  3. 掌握后动手:可直接使用 第 10 章 代码生成器 一键生成同等结构的模块。
`,13)])])}const m=s(l,[["render",t]]);export{u as __pageData,m as default};