华山资源网

yii2 开发api接口时优雅的处理全局异常的方法
网络编程 2024/9/23 佚名
3 1

前言：个人觉得，学习或温习一套Web框架，在快速阅读一遍文档后，应从路由，控制器，请求/响应对象，数据模型（Logic，Dao，Entity），全局异常处理几个方面下手，这几项了解后，框架上手就游刃有余了。然后我比较喜欢在开工前整理好框架的全局异常处理，方便写 api时错误的统一响应。

在api接口的开发过程中，我们需要对用户数据进行严格的校验，防止非法输入对服务产生安全问题，在开发过程中，我比较喜欢即时的以抛出异常的方式中断请求的处理，并以全局异常处理器格式化处理后统一返回给客户端。

今天就把 yii2 自带的全局异常处理器改写至对 api 友好（yii2的 yii\web\HttpException默认对 web 请求友好，都是以text/html的方式返回错误描述，对api不友好，api当然是json）。

注册异常处理器

yii2也是以 controller/action 的方式定义一个异常处理器的，我们可以在 components=>errorHandler中自定义。

# config/web.php
'components' => [
  'errorHandler' => [
    'errorAction' => 'exception/handler'
  ]
]

异常处理器

定义相应的异常处理器，app\actions\ErrorApiAction 继承 yii\web\ErrorAction，可以拿到yii2为我们整理好的全局异常。

# controllers/ExceptionController.php
<"htmlcode">



#actions/ErrorApiAction.php
<"color: #ff0000">异常实体


主要是简单的把状态码的传递封装一下，用更容易理解的类名来代理传递。

exceptions/HttpException.php





<"htmlcode">



<"htmlcode">



<"htmlcode">



<"htmlcode">



<"color: #ff0000">使用范例


在一些 service logic model 中根据需要即时抛出异常即可，上层控制器拿到的永远都是正常的返回数据，绝对的2xx响应簇





throw new HttpBadRequestException("具体的非法描述", 4001);
throw new HttpUnauthorizedException("请认证后访问");
throw new HttpForbiddenException("无权访问");
throw new HttpNotFoundException("请求资源不存在");





yii2 开发api接口时优雅的处理全局异常的方法


以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持。


                                

                                

                                     

                                
华山资源网 Design By www.eoogi.com

                            

                        

                        

                            

                                广告合作：本站广告合作请联系QQ：858582 申请时备注：广告合作（否则不回）

                                免责声明：本站资源来自互联网收集,仅供用于学习和交流,请遵循相关法律法规,本站一切资源不代表本站立场,如有侵权、后门、不妥请联系本站删除！
                            

                        

                        

                            
                            
                        

                        
                        
华山资源网 Design By www.eoogi.com

                        
                        
                    

                    

                        

                            

                                

                                    

                                        

                                    

                                    

                                        

                                            
                                        

                                    

                                

                                

                                    
www.eoogi.com
                                            
                                                华山资源网 
                                    

                                    

                                        

                                            
                                        

                                        

                                            
                                        

                                        

                                            
                                        

                                        

                                            
                                        

                                    

                                    

                                    

                                        

                                            120,135影音资源
                                        

                                        

                                            344,641技术资源
                                        

                                        

                                            22,817软件资源
                                        

                                        

                                            435,032站长资源

更新日志

友情链接

杰晶网络 DDR爱好者之家 桃源资源网 杰网资源 富贵资源网 南强小屋 铁雪资源网 幽灵资源网 万梅资源网 狼山资源网 白云岛资源网 昆仑资源网 相思资源网 明霞山资源网 内蒙古资源网 黑松山资源网 茶园资源网 饿虎岗资源网 大旗谷资源网 常春岛资源网 岱庙资源网 兴国资源网 快活林资源网 蝙蝠岛资源网 帝王谷资源网 白云城资源网 伏龙阁资源网 清风细雨楼 天枫庄资源网 圆月山庄资源网 无争山庄资源网 神水资源网 移花宫资源网 神剑山庄资源网 无为清净楼资源网 金钱帮资源网 丐帮资源网 华山资源网 极乐门资源网 小李飞刀资源网 凤求凰客栈 风云阁资源网 金狮镖局 鸳鸯亭资源网 千金楼资源网 更多链接
华山资源网 Design By www.eoogi.com