Skip to content

jzxyouok/phprs

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

phprs

这是一个轻量级框架,专为快速开发RESTful接口而设计。如果你和我一样,厌倦了使用传统的MVC框架编写微服务或者前后端分离的API接口,受不了为了一个简单接口而做的很多多余的coding(和CTRL-C/CTRL-V),那么,你肯定会喜欢这个框架!

要求:PHP5.4+

先举个栗子

  1. 写个HelloWorld.php,放到框架指定的目录下(默认是和index.php同级的apis/目录)

    /**
     * @path("/hw")
     */
    class HelloWorld
    {
        /** 
         * @route({"GET","/"})
         */
        public function doSomething() {
            return "Hello World!";
        }
    }
  2. 浏览器输入http://your-domain/hw/ 你将看到:Hello World!就是这么简单,不需要额外配置,不需要继承也不需要组合。

发生了什么

回过头看HelloWorld.php,特殊的地方在于注释(@path,@route),没错,框架通过注释获取路由信息和绑定输入输出。但不要担心性能,注释只会在类文件修改后解析一次。更多的@注释后面会说明。

再看个更具体的例子

这是一个登录接口

/**
 * 用户权限验证
 * @path("/tokens/") 
 */
class Tokens
{ 
    /**
     * 登录
     * 通过用户名密码授权
     * @route({"POST","/accounts/"}) 
     * @param({"account", "$._POST.account"}) 账号
     * @param({"password", "$._POST.password"}) 密码
     * 
     * @throws ({"InvalidPassword", "res", "403 Forbidden", {"error":"InvalidPassword"} }) 用户名或密码无效
     * 
     * @return({"body"})    
     * 返回token,同cookie中的token相同,
     * {"token":"xxx", "uid" = "xxx"}
     *
     * @return({"cookie","token","$token","+365 days","/"})  通过cookie返回token
     * @return({"cookie","uid","$uid","+365 days","/"})  通过cookie返回uid
     */
    public function createTokenByAccounts($account, $password, &$token,&$uid){
        //验证用户
        $uid = $this->users->verifyPassword($account, $password);
        Verify::isTrue($uid, new InvalidPassword($account));
        $token = ...;
        return ['token'=>$token, 'uid'=>$uid];
    } 
    /**
     * @property({"default":"@Users"})   依赖的属性,由框架注入
     * @var Users
     */
    public $users;
}

还能做什么

  1. 依赖管理(依赖注入),
  2. 自动输出接口文档(不是doxgen式的类、方法文档,而是描述http接口的文档)
  3. 接口缓存
  4. hook

为什么又多一个框架

开源PHP框架已经很多,仅仅是适合开发Restful的PHP框架就不乏优秀的,如laravel、anandkunal/ToroPHP、peej/tonic等等,那么为何还有phprs呢?自己总结一下主要有几个原因:

  1. 总是一起做的事情,就要放在一起做:比如通常实现一个新功能,需要:定义接口、实现代码、配置路由、写接口文档,而大部分框架需要程序猿们切换到不同地方(场景)去做这些事情;反过来讲,不相关的,却又通常耦合在一起,比如路由定义。

  2. 低倾入性:大部分框架都过多的干涉了上层的代码,比如需要通过继承使用框架的功能。而我希望的框架是:“看起来像没有框架”。

  3. 好的依赖管理:依赖注入是一项很好的依赖管理方法,但大部分框架没有提供,而是给了类似全局配置实例的东西,或者依赖注入使用起来别扭。

担心可用性?

此框架目前支持线上亿级PV。有问题或意见也欢迎联系我:caoyangmin@gmail.com

手册

请移步wiki

About

高效轻便RESTful框架,开箱即用,适用于前后端分离API、微服务 ./ RESTful PHP library/framework: IoC, @annotation, jax-rs like.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • PHP 100.0%