本篇文章给大家带来了关于thinkphp的相关知识，其中主要介绍了搭建后端api接口的相关问题，主要内容有下载tp6、隐藏入口文件、解决跨域问题等等，希望对大家有帮助。
|
本篇文章给大家带来了关于thinkPHP的相关知识，其中主要介绍了搭建后端api接口的相关问题，主要内容有下载tp6、隐藏入口文件、解决跨域问题等等，希望对大家有帮助。
推荐学习：《PHP视频教程》 1、下载tp6我使用的是集成环境phpstuday,安装了composer，通过composer安装tp6,thinkphp官网已经不再支持直接下载。 composer create-project topthink/think tp6 你也可以直接按照tp6看云文档的步骤来安装tp6 在下载好的tp6目录通过cmd命令窗口输入 php think run 在浏览器中输入127.0.0.1:8000，访问到如下页面就安装成功了 2、打开错误调试在开始之间，我们先打开tp6的错误调试 3、隐藏入口文件在第1节中，我们访问
实际访问的是
你也可以通过这样的方式访问
如果什么都不填，默认访问的就是index控制器，在config/app.php文件中有这样的定义，你也可以修改默认的控制器 为什么要隐藏入口文件？
我这里因为用的集成环境，选用的是apache服务器，所以我只找了apache的隐藏入口文件的方法，nginx的需要自己搜索了。 当我想通过
去访问方法时，访问失败
<IfModule mod_rewrite.c> #如果mode_rewrite.c模块存在 则执行以下命令
Options +FollowSymlinks -Multiviews
RewriteEngine On #开启 rewriteEngine
# !-d 不是目录或目录不存在
RewriteCond %{REQUEST_FILENAME} !-d
# !-f 不是文件或文件不存在
RewriteCond %{REQUEST_FILENAME} !-f
RewriteRule ^(.*)$ index.php [QSA,PT,L]
# 参数解释
# ^(.*)$： 匹配所有的路口映射
# QSA: （Query String Appending）表示保留参数入get传值？xxx==xx;
# PT: 把这个URL交给Apache处理；
# L: 作为最后一条，遇到这条将不再匹配这条之后的规则</IfModule>现在访问
访问成功 需要注意，在第一节中我们看到，运行了php think run 后，我们的项目目录访问的是public目录 4、解决跨域问题在应用开发中，前后端都是分开独立开发的，而前后端通常都会自己搭建一个web服务，运行在不同的端口上，在前端访问后端的接口时，会报跨域的错误。而这种跨域问题通常是要有后端来处理的，tp6有专门的中间件来做这个事情，真是太方便了，只需要在app目录下的middleware.php中添加该中间件，就实现了跨域访问。 <?php// 全局中间件定义文件return [
// 全局请求缓存
// \think\middleware\CheckRequestCache::class,
// 多语言加载
// \think\middleware\LoadLangPack::class,
// Session初始化
// \think\middleware\SessionInit::class
// 跨域解决
\think\middleware\AllowCrossDomain::class,];5、路由解决api版本控制在app目录中的container控制器中新建两个文件夹v1,v2,在其中都创建User.php文件 <?phpnamespace app\controller\v1;use app\BaseController;class User extends BaseController{
public function login()
{
return '我是v1';
}}v2/User.php <?phpnamespace app\controller\v2;use app\BaseController;class User extends BaseController{
public function login()
{
return '我是v2';
}}注意上面两个文件的命名空间，就第一行代码，在哪个文件夹下，就写到哪里。 至于路由的概念去文档自己看。我这里主要用路由组的方式，我觉得这个比资源路由好用，灵活。 在根目录下的route目录下的app.php文件代码如下： <?php// +----------------------------------------------------------------------// | ThinkPHP [ WE CAN DO IT JUST THINK ]// +----------------------------------------------------------------------// | Copyright (c) 2006~2018 http://thinkphp.cn All rights reserved.// +----------------------------------------------------------------------// | Licensed ( http://www.apache.org/licenses/LICENSE-2.0 )// +----------------------------------------------------------------------// | Author: liu21st <liu21st@gmail.com>// +----------------------------------------------------------------------use think\facade\Route;// api版本控制$v = request()->header('Api-Version');// 默认api版本为v1if ($v == null) $v = "v1";// 用户Route::group('user', function () {
Route::post('login', 'login');})->prefix($v.'.user/')->pattern(['id' => '\d+']);以上代码进行控制api版本的方式是，请求发起者在header中传递要访问的api的版本，这里获取到对应的版本，访问对应的方法。 鉴于以上我使用的是post请求，且要传递header，所以使用postman进行测试。 6、jwt token验证我用的是tp6看云文档收录的插件 composer require thans/tp-jwt-auth 该插件的github地址-文档 安装完成后，该插件所在的位置在根目录下的vendor/thans/tp-jwt-auth php think jwt:create 会帮你在.env文件中生成密钥secret,红色框中的是新增的内容
(1).生成token我就在之前创建的v1/User.php控制器中写了 <?phpnamespace app\controller\v1;use app\BaseController;// 引入jwt插件use thans\jwt\facade\JWTAuth;class User extends BaseController{
public function login()
{
// 生成token
$token = JWTAuth::builder(['uid' => 1,'name'=>'ceshi']);
return $token;
}}在postman中测试 (2).验证token我使用的是路由中间件的方式验证token， 写一个中间件在根目录下的app目录中创建middleware目录，在其下创建CheckToken.php文件 <?phpnamespace app\middleware;use thans\jwt\facade\JWTAuth;use thans\jwt\exception\JWTException;class CheckToken{
public function handle($request, \Closure $next)
{
// OPTIONS请求直接返回
if ($request->isOptions()) {
return response();
}
try {
JWTAuth::auth();
}catch (JWTException $e) {
return json($e->getMessage());
}
return $next($request);
}}起别名给该中间件起个别名，在根目录下的config/middleware.php文件中 在路由文件中使用中间件
创建对应的方法在第三步中我们创建了一个getUserInfo()方法，现在在User.php文件中创建 public function getUserInfo() {
return json(['id'=>1, 'name'=> '啦啦啦']);}
验证一下刚刚创建的token必然过期了，咱重新获取一条 现在验证一下,请求userinfo方法，并在header中添加参数Authorization， (3).注销token这个插件在github中的文档中没有说到怎么注销或删除token,只有一个刷新refresh和拉黑invalidate,我看了一下它的代码，刷新方法中会调用拉黑方法，看到这个注释，让我激动了一下，鸡儿！原来拉黑就是注销 文件内容形似这样 什么？ 7、统一的参数返回形式实际开发中，后端返回给前端的参数往往都是这样的。 <?phpuse think\Response;// 应用公共文件// 统一返回数据格式function result($data = [], string $msg = 'error', int $code = 200, string $type = 'json'):Response {
$result = [
"code" => $code,
"msg" => $msg,
"data" => $data
];
// 调用Response的create方法，指定code可以改变请求的返回状态码
return Response::create($result, $type)->code($code);}唉，这个时候，经验的重要性就体现出来，我是个前端，而且在我自己看来，还算是个没有工作经验的前端，
调用就很简单了，可以直接使用 public function login(){
$data = [
['id'=>1,'name'=>'杰森'],
['id'=>2,'name'=>'麦克']
];
$code = 200;
$msg = '获取成功';
return result($data, $msg, $code);
}
7、异常捕捉异常捕捉（看云文档）内容挺多的，自己去百度吧，我就把我遇到过的常见的错误进行捕捉，其它的异常我也爱莫能助，不懂啊 !>_>! （1）参数验证错误捕捉我们先写一个参数验证的类，在app目录下创建validate目录，创建User.php文件 <?phpnamespace app\validate;use think\Validate;class User extends Validate{
protected $rule = [
'name' => 'require|max:25',
'age' => 'number|between:1,120',
'email' => 'email',
];
protected $message = [
'name.require' => '名称必须',
'name.max' => '名称最多不能超过25个字符',
'age.number' => '年龄必须是数字',
'age.between' => '年龄只能在1-120之间',
'email' => '邮箱格式错误',
];
}tp6的异常捕捉分为两种，自动和手动的，手动的就是通过try{}catch{}捕捉。tp6的异常捕捉大多是自动的，不过，比如我们现在要操作的参数验证错误就需要自己去捕捉来抛出异常，我们此节的目的是统一捕捉这个错误，我就不用手动的了。 // 1.参数验证错误
if ($e instanceof ValidateException) {
return result($e->getError(), '参数验证不通过', 422);
}现在在方法中一下，看看能否捕获。 （2）未匹配到资源或方法的异常捕获我还没找到方法，在我的预想中这个应该要做到能够准确的反应未匹配到的原因。 // 2.方法（控制器、路由、http请求）、资源（多媒体文件，如视频、文件）未匹配到，// 一旦在定义的路由规则中匹配不到，它就会直接去匹配控制器，但是因为在控制器中做了版本控制v1,v2这样的，所以它是无法获取对应控制器的// 所以都会直接走了HttpException的错误// 感觉好像也无所谓，反正是做api接口的，只不过这样就不好准确的提示信息了// 到底这个请求时控制器找不到呢？还是方法找不到？还是请求类型（get,post）不对？if(($e instanceof ClassNotFoundException || $e instanceof RouteNotFoundException) || ($e instanceof HttpException && $e->getStatusCode()==404)){
$data = [
'err_msg' => $e -> getMessage(),
'tips_1' => '请检查路径是否是否填写正确',
'tips_2' => '请检查请求类型是否正确',
];
return result($data, '方法或资源未找到，请检查', 404);}下面就不写了，太麻烦了，直接放全部代码<?phpnamespace app;use ParseError; // 语法错误use TypeError;use InvalidArgumentException; // 参数错误use think\db\exception\DataNotFoundException;use think\db\exception\ModelNotFoundException;use think\db\exception\PDOException; // 数据库连接错误use think\db\exception\DbException; // 数据库模型访问错误，比如方法不存在use think\exception\RouteNotFoundException;use think\exception\ClassNotFoundException;use think\exception\FuncNotFoundException;use think\exception\FileException;use think\exception\Handle;use think\exception\HttpException;use think\exception\HttpResponseException;use think\exception\ValidateException;use think\exception\ErrorException;use think\Response;use Throwable;/**
* 应用异常处理类
*/class ExceptionHandle extends Handle{
/**
* 不需要记录信息（日志）的异常类列表
* @var array
*/
protected $ignoreReport = [
HttpException::class,
HttpResponseException::class,
ModelNotFoundException::class,
DataNotFoundException::class,
ValidateException::class,
];
/**
* 记录异常信息（包括日志或者其它方式记录）
*
* @access public
* @param Throwable $exception
* @return void
*/
public function report(Throwable $exception): void
{
// 使用内置的方式记录异常日志
parent::report($exception);
}
/**
* Render an exception into an HTTP response.
*
* @access public
* @param \think\Request $request
* @param Throwable $e
* @return Response
*/
public function render($request, Throwable $e): Response
{
// 添加自定义异常处理机制
// 请求异常
if ($e instanceof HttpException && $request->isAjax()) {
return response($e->getMessage(), $e->getStatusCode());
}
// 使用了错误的数据类型 或 缺失参数
if ($e instanceof InvalidArgumentException || $e instanceof ErrorException) {
$fileUrlArr = explode(DIRECTORY_SEPARATOR, $e->getFile());
$data = [
'err_msg' => $e->getMessage(),
'file' => $fileUrlArr[count($fileUrlArr) - 1],
'line' => $e->getLine()
];
return result($data, '参数错误', 413);
}
// 1.参数验证错误
if ($e instanceof ValidateException) {
return result($e->getError(), '参数验证不通过', 422);
}
// 2.方法（控制器、路由、http请求）、资源（多媒体文件，如视频、文件）未匹配到，
// 一旦在定义的路由规则中匹配不到，它就会直接去匹配控制器，但是因为在控制器中做了版本控制v1,v2这样的，所以它是无法获取对应控制器的
// 所以都会直接走了HttpException的错误
// 感觉好像也无所谓，反正是做api接口的，只不过这样就不好准确的提示信息了
// 到底这个请求时控制器找不到呢？还是方法找不到？还是请求类型（get,post）不对？
if(($e instanceof ClassNotFoundException || $e instanceof RouteNotFoundException) || ($e instanceof HttpException && $e->getStatusCode()==404)){
$data = [
'err_msg' => $e -> getMessage(),
'tip_1' => '请检查路径是否是否填写正确',
'tips_2' => '请检查请求类型是否正确',
];
return result($data, '方法或资源未找到，请检查', 404);
}
// 3.语法错误
if ($e instanceof ParseError) {
$fileUrlArr = explode(DIRECTORY_SEPARATOR, $e->getFile());
$data = [
'err_msg' => $e->getMessage(),
'file' => $fileUrlArr[count($fileUrlArr) - 1],
'line' => $e->getLine()
];
return result($data, '服务器异常-语法错误', 411);
}
// 4.数据库错误
if ($e instanceof PDOException || $e instanceof DbException) {
$fileUrlArr = explode(DIRECTORY_SEPARATOR, $e->getFile());
$data = [
'err_msg' => $e->getMessage(),
'file' => $fileUrlArr[count($fileUrlArr) - 1],
'line' => $e->getLine()
];
return result($data, '服务器异常-数据库错误', 412);
}
// 其他错误交给系统处理
return parent::render($request, $e);
}}本节结束，这里面用的错误处理都是我在平常练习中遇到的错误，至于其他的没有处理是因为我还没碰到，碰到再说吧。为了给前端好的反馈，我们应该处理所有的异常的返回形式，不然，tp6默认返回页面形式的，前端等于得不到相应了。至于这个自定义异常捕获，应该有相应的插件的吧，你要是感兴趣可以去找找。 7、自动生成api文档之前我还很好奇，后端是怎么搞出接口文档的，都是自己录入数据套模板的吗？原来他么的都是插件做的，真他么方便！！！ （1）安装插件composer require hg/apidoc// 文档// https://hgthecode.github.io/thinkphp-apidoc/guide/install/ 你就照着插件的文档来就好了，不用跟着我。 （2）下载对应的前端页面下载最新的，放在public目录下 （3）使用具体配置你还得看文档，我就直接照着最简单的做了， 引入注释app/controller/v1/User.php <?phpnamespace app\controller\v1;use app\BaseController;// 添加这句，注释写法为 @Apidoc\参数名(...)use hg\apidoc\annotation as Apidoc;/**
* @Apidoc\Title("V1")
* @Apidoc\Group("base")
*/class User extends BaseController{
/**
* @Apidoc\Title("登录")
* @Apidoc\Url("v1.user/login")
* @Apidoc\Tag("测试 基础")
* @Apidoc\Param("username", type="string",require=true, desc="用户名" )
* @Apidoc\Param("password", type="string",require=true, desc="密码" )
* @Apidoc\Returned("id", type="int", desc="新增用户的id")
*/
public function login()
{
return result(null, '成功', 200);
}}查看效果
#后记：当时只是练习一下我，我也没深究，but其实这个apidoc它的官方文档里有设置项的，关于这个多应用/多版本的配置项，去apidoc的文档去看吧，在config/apidoc.php修改apps的配置就可以了，然后就可以通过右上角的选择框切换版本了 // 设置应用/版本（必须设置）
'apps' => [
[
'title'=>'演示示例',
'path'=>'app',
'folder'=>'controller',
'items'=>[
['title'=>'V1.0','path'=>'app\controller\v1','folder'=>'v1'],
['title'=>'V2.0','path'=>'app\controller\v2','folder'=>'v2']
]
],
],推荐学习：《PHP视频教程》 以上就是实例详解thinkphp6搭建后端api接口的详细内容，更多请关注模板之家(www.mb5.com.cn)其它相关文章！ |
