Ubiquity控制器开发指南：路由、依赖注入与RESTful API实现

Ubiquity控制器开发指南：路由、依赖注入与RESTful API实现

【免费下载链接】ubiquityUbiquity framework项目地址: https://gitcode.com/gh_mirrors/ub/ubiquity

Ubiquity是一个功能强大的PHP框架，提供了简洁高效的控制器开发方式，支持灵活的路由管理、依赖注入和RESTful API实现。本文将详细介绍如何在Ubiquity框架中开发控制器，掌握路由配置、依赖注入和RESTful API设计的核心技巧。

控制器基础与路由配置

Ubiquity控制器是处理HTTP请求的核心组件，通过路由将URL映射到控制器的方法。控制器类通常继承自Controller或其派生类，如SimpleViewController或RestResourceController。

路由定义方式

Ubiquity支持多种路由定义方式，包括注解路由和配置文件路由。最常用的是通过注解直接在控制器方法上定义路由：

#[Route(path: "/users", methods: ["get"])] public function index() { // 处理GET请求，返回用户列表 }

路由参数可以通过正则表达式进行约束，确保请求参数的有效性：

#[Route(path: "/users/{id:[0-9]+}", methods: ["get"])] public function getUser($id) { // 根据ID获取用户信息 }

路由管理工具

Ubiquity提供了Router类来管理应用中的所有路由，通过Router::getRouteInfoByName方法可以根据路由名称获取路由信息，便于在控制器中进行重定向：

public function redirectToUser($id) { return $this->redirectToRoute("user.detail", ["id" => $id]); }

上图展示了Ubiquity CRUD控制器的路由管理界面，通过直观的界面可以快速配置和管理控制器路由。

依赖注入实现

Ubiquity的依赖注入系统由DiManager和DiControllerParser组成，用于管理控制器的依赖关系，实现松耦合的代码设计。

依赖注入基础

依赖注入允许在控制器中声明所需的服务或组件，框架会自动实例化并注入这些依赖。例如，在控制器中注入数据库连接：

class UserController extends Controller { #[Inject("database")] private $db; public function index() { $users = $this->db->getAll("users"); // 处理用户数据 } }

依赖注入配置

依赖注入的配置可以在config/services.php文件中进行，定义服务的实例化方式和作用域：

return [ "database" => function() { return new Database("mysql:host=localhost;dbname=test", "user", "pass"); } ];

DiManager负责管理依赖注入的缓存和实例化，通过DiControllerParser解析控制器中的依赖声明，确保依赖正确注入。

RESTful API开发

Ubiquity提供了RestResourceController和JsonApiRestController等类，简化RESTful API的开发过程，支持标准的HTTP方法和JSON API规范。

创建REST控制器

创建RESTful API控制器只需继承RestResourceController，并指定资源模型：

class UserRestController extends RestResourceController { protected $model = "models\User"; }

框架会自动生成标准的RESTful路由，包括GET、POST、PUT、DELETE等方法，对应资源的查询、创建、更新和删除操作。

API路由与测试

Ubiquity的REST控制器会自动注册以下路由：

• GET /users - 获取所有用户
• GET /users/{id} - 获取单个用户
• POST /users - 创建新用户
• PUT /users/{id} - 更新用户信息
• DELETE /users/{id} - 删除用户

上图展示了Ubiquity的JSON API管理界面，可以查看和测试API路由，包括请求方法、参数和缓存设置。

命令行工具辅助开发

Ubiquity提供了丰富的命令行工具，帮助开发者快速生成控制器和管理路由缓存。例如，使用init-cache命令初始化路由缓存：

Ubiquity init-cache -t controllers

上图显示了init-cache命令的帮助信息，通过命令行工具可以方便地管理控制器缓存和路由配置。

总结

Ubiquity框架提供了强大而灵活的控制器开发功能，通过路由管理、依赖注入和RESTful API支持，帮助开发者快速构建高效的Web应用。掌握这些核心技术，可以显著提高开发效率，编写更加清晰、可维护的代码。

官方文档：docs/controller/controllers.rst 控制器源码：src/Ubiquity/controllers/ REST API源码：src/Ubiquity/controllers/rest/

【免费下载链接】ubiquityUbiquity framework项目地址: https://gitcode.com/gh_mirrors/ub/ubiquity