技术 · 思考 · 实践 · 成长

首页/ThinkPHP8/正文

ThinkPHP 8 控制器完全指南:定义、初始化、返回输出与请求对象

ThinkPHP87 次阅读

控制器负责接收请求、调用业务、返回响应。官方手册《控制器》一章下设多个子类:控制器定义、控制器初始化、前置操作、跳转和重定向、返回输出、获取请求对象、获取当前控制器/操作名、多级控制器。本文逐一整理,结尾附综合小实例。参考:ThinkPHP 8 控制器。

一、控制器定义

控制器放在 app/controller 目录下,命名空间 appcontroller,类名与文件名一致(大驼峰);类中的 public 方法就是可被访问的操作:

<?php
namespace appcontroller;

class Blog
{
    public function read($id)
    {
        return 'blog id = ' . $id;
    }
}

URL 访问 /blog/read/id/10(或经路由映射)就会调用 Blog 控制器的 read 操作。

二、控制器初始化

继承 thinkController 后,可以定义 initialize() 方法做初始化,它会在操作执行前自动调用:

<?php
namespace appcontroller;

use thinkController;

class Blog extends Controller
{
    protected function initialize()
    {
        // 公共初始化:统一赋值、环境检查等
    }
}

三、前置操作与公共逻辑

多个操作都要执行的公共检查(登录、权限),可以封装到基类方法里显式调用,也可以改用中间件 —— 中间件是 TP8 推荐的横切逻辑写法:

class AdminBase extends Controller
{
    protected function checkLogin()
    {
        if (empty(session('user'))) {
            $this->error('请先登录', 'login/index');
        }
    }
}

class Blog extends AdminBase
{
    public function index()
    {
        $this->checkLogin();   // 前置检查
        // 业务逻辑...
    }
}

四、跳转和重定向

继承 thinkController 后可使用内置跳转方法:

方法作用
$this->success('提示', '跳转地址')成功提示并跳转(自动识别 AJAX 返回 JSON)
$this->error('提示', '跳转地址')失败提示并跳转
$this->redirect('地址', 302)直接重定向到指定地址

不继承基类时,可以用 redirect() 助手函数返回重定向响应。

五、返回输出

返回形式示例说明
字符串return 'hello';直接输出内容
数组return ['id' => 1];自动转成 JSON 响应
json()return json($data);JSON 响应,可指定状态码
视图return view('blog/index', ['list' => $list]);渲染模板
重定向return redirect('blog/index');302 跳转

需要完全控制响应时,可以返回 hink esponseJson、 hink esponseView 等响应对象。

六、获取请求对象与参数

use thinkRequest;

class Blog
{
    // 方法注入 Request 对象
    public function read(Request $request, $id)
    {
        $name = $request->get('name');   // GET 参数
        $data = $request->post();          // 全部 POST 参数
        $all  = $request->param();         // 所有参数(含路由参数)
    }
}

也可以在任何地方用 request() 助手函数获取:request()->param('id')。路由变量会合并进 param,直接使用即可。

七、获取当前控制器/操作名

$request = request();
$request->controller();   // 当前控制器名
$request->action();       // 当前操作名

八、多级控制器

控制器可以放在子目录里形成多级控制器,URL 用小数点访问:

// 文件:app/controller/admin/Blog.php
namespace appcontrolleradmin;

class Blog
{
    public function index()
    {
        return 'admin blog';
    }
}

访问 /admin.blog/index,路由目标写 admin.blog/index。

九、综合小实例:文章控制器

把本章知识点串起来,写一个文章控制器:

<?php
namespace appcontroller;

use thinkController;

class Blog extends Controller
{
    protected function initialize()
    {
        // 公共初始化
    }

    // 列表:返回视图
    public function index()
    {
        $list = [['id' => 1, 'title' => 'ThinkPHP 路由']];
        return view('blog/index', ['list' => $list]);
    }

    // 详情:接收路由参数 + 返回 JSON
    public function read($id)
    {
        if (!is_numeric($id)) {
            return json(['code' => 0, 'msg' => '参数错误'], 400);
        }
        return json(['code' => 1, 'id' => $id]);
    }

    // 发布:读取 POST + 跳转提示
    public function create()
    {
        $data = request()->post();
        if (empty($data['title'])) {
            $this->error('标题不能为空');
        }
        $this->success('发布成功', 'blog/index');
    }
}

配合上一篇的路由知识(Route::resource('blog', 'Blog') 或 get/post 路由)即可工作 —— 这个小例子把控制器定义、初始化、请求对象、返回输出、跳转方法全用上了。

十、总结

控制器四件事:定义在 app/controller(大驼峰、方法即操作);initialize 做初始化、公共检查用基类或中间件;返回输出有字符串/数组/json/view/redirect 五种形式;参数获取用 Request 注入或 request() 助手;多级控制器用小数点访问。

凡人做一事,便须全副精神注在此一事,首尾不懈,不可见异思迁,做这样,想那样,坐这山,望那山。人而无恒,终身一无所成。——曾国藩《曾国藩家书》

评论交流

0 条评论 · 支持多级回复
验证码
暂无评论,来说说你的想法吧

相关文章

继续阅读