【PhpBoot】为快速开发 RESTful API 设计的PHP框架

mist14 发布于2019-06-28 13:22 / 1354人阅读

摘要：是为快速开发设计的框架。特色框架提供许多主流的特性如依赖注入等。轻松支持是目前最流行的接口文档框架。在一开始就非常注重框架的友好性尽可能让框架保持准确的代码提示。

PhpBoot

PhpBoot 是为快速开发 RESTful API 设计的PHP框架。它可以帮助开发者更聚焦在业务本身, 而将原来开发中不得不做, 但又重复枯燥的事情丢给框架, 比如编写接口文档、参数校验和远程调用代码等。

特色

PhpBoot 框架提供许多主流的特性, 如ORM、依赖注入等。这些特性都经过精心设计和选择(有些是第三方开源代码,如 PHP-DI)，但和其他框架相比较, PhpBoot 最显著的特色是:

1. 以面向对象的方式编写接口

你肯定看到过这样的代码:

// **不用** PhpBoot 的代码
class BookController
{
    public function findBooks(Request $request)
    {
        $name = $request->get("name");
        $offset = $request->get("offset", 0);
        $limit = $request->get("limit", 10);
        ...
        return new Response(["total"=>$total, "data"=>$books]);
    }
    
    public function createBook(Request $request)
    ...
}

很多主流框架都需要用类似代码编写接口。但这种代码的一个问题是, 方法的输入输出隐藏在实现里, 这不是通常我们提倡的编码方式。如果你对代码要求更高, 你可能还会实现一层 Service 接口, 而在 Controller 里只是简单的去调用 Service 接口。而使用 PhpBoot, 你可以用更自然的方式去定义和实现接口。上面的例子, 在 PhpBoot 框架中实现是这样的:

/**
 * @path /books/
 */
class Books
{
    /**
     * @route GET /
     * @return Book[]
     */
    public function findBooks($name, &$total=null, $offset=0, $limit=10)
    {
        ...
        return $books;
    }
  
    /**
     * @route POST /
     * @param Book $book {@bind request.request} bind $book with http body
     * @return string id of created book
     */
    public function createBook(Book $book)
    {
        $id = ... 
        return $id;
    }
}

上面两份代码执行的效果是一样的。可以看到 PhpBoot 编写的代码更符合面向对象编程的原则, 以上代码完整版本请见phpboot-example。

2. 轻松支持 Swagger

Swagger是目前最流行的接口文档框架。虽然很多框架都可以通过扩展支持Swagger, 但一般不是需要编写很多额外的注释, 就是只能导出基本的路由信息, 而不能导出详细的输入输出参数。而 PhpBoot 可以在不增加额外编码负担的情况下, 轻松去完成上述任务，下图为findBooks对应的文档。更多内容请见文档和在线 Demo。

3. 简单易用的分布式支持

使用 PhpBoot 可以很简单的构建分布式应用。通过如下代码, 即可轻松远程访问上面示例中的 Books 接口:

$books = $app->make(RpcProxy::class, [
        "interface"=>Books::class, 
        "prefix"=>"http://x.x.x.x/"
    ]);
    
$books->findBooks(...);

同时还可以方便的发起并发请求, 如:

$res = MultiRpc::run([
    function()use($service1){
        return $service1->doSomething();
    },
    function()use($service2){
        return $service2->doSomething();
    },
]);

更多内容请查看文档

4. IDE 友好

IDE 的代码提示功能可以让开发者轻松不少, 但很多框架在这方面做的并不好, 你必须看文档或者代码, 才能知道某个功能的用法。PhpBoot 在一开始就非常注重框架的 IDE 友好性, 尽可能让框架保持准确的代码提示。比如下图是 DB 库在 PhpStorm 下的使用:

主要特性

基于Annotation的路由定义

接口参数双向绑定

Validation

依赖注入

ORM

自动文档和接口工具

分布式支持(RPC)

Hook

工作流引擎(开发中...)

安装和配置

安装 composer (已安装可忽略)

curl -s http://getcomposer.org/installer | php

安装 PhpBoot

composer require "caoym/phpboot"

index.php 加载 PhpBoot

loadRoutesFromPath(__DIR__."/App/Controllers");
$app->dispatch();

帮助和文档

在线文档

QQ 交流群:185193529

本人邮箱 caoyangmin@gmail.com

云服务器 GPU云服务器 php的api设计 RESTful框架 java快速开发框架 android快速开发框架

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/25599.html

PhpBoot 入门（二）面向对象的方式编写 SQL

摘要：是一款为快速开发而设计的框架加星请点这里。对进行了封装，使开发者可以更方便的编写正确和安全的。下面将继续上一篇快速开发接口的示例，介绍的使用。配置可以通过依赖注入的方式，对数据库进行配置。 showImg(https://segmentfault.com/img/remote/1460000010831389); PhpBoot 是一款为快速开发 RESTful API 而设计的PHP...

whinc 2019-06-28 13:32 评论0 收藏0
后端API从入门到放弃指北

摘要：菜鸟教程框架中文手册入门目标使用搭建通过对数据增删查改没了纯粹占行用的拜后端API入门学习指北了解一下一下概念. RESTful API标准] 所有的API都遵循[RESTful API标准]. 建议大家都简单了解一下HTTP协议和RESTful API相关资料. 阮一峰:理解RESTful架构阮一峰:RESTful API 设计指南 RESTful API指南依赖注入 D...

Jeffrrey 2019-08-16 12:31 评论0 收藏0
后端API从入门到放弃指北

摘要：菜鸟教程框架中文手册入门目标使用搭建通过对数据增删查改没了纯粹占行用的拜后端API入门学习指北了解一下一下概念. RESTful API标准] 所有的API都遵循[RESTful API标准]. 建议大家都简单了解一下HTTP协议和RESTful API相关资料. 阮一峰:理解RESTful架构阮一峰:RESTful API 设计指南 RESTful API指南依赖注入 D...

sf190404 2019-07-30 16:53 评论0 收藏0
后端API从入门到放弃指北

摘要：菜鸟教程框架中文手册入门目标使用搭建通过对数据增删查改没了纯粹占行用的拜后端API入门学习指北了解一下一下概念. RESTful API标准] 所有的API都遵循[RESTful API标准]. 建议大家都简单了解一下HTTP协议和RESTful API相关资料. 阮一峰:理解RESTful架构阮一峰:RESTful API 设计指南 RESTful API指南依赖注入 D...

Airmusic 2019-07-01 10:10 评论0 收藏0