CodeIgniter 4.1.9 单条AJAX POST路由404/500错误排查

问题背景 #

• 使用CodeIgniter 4.1.9框架开发时，单个配置了路由的控制器无法正常接收AJAX POST请求，耗时数周排查、尝试多种修复及变通方案均未定位问题根源
• 项目内其余20余个控制器均配置了独立POST路由与校验逻辑，所有接口可正常完成数据CRUD操作，仅Platform\CloudNine控制器下的相关接口返回异常

相关配置与代码 #

路由配置 #

$routes->post('createNewCloudGoal', 'Platform\CloudNine::createNewCloudGoal');
$routes->post('getCloudGoal', 'Platform\CloudNine::getCloudGoal');
$routes->post('completeCloudGoal', 'Platform\CloudNine::completeCloudGoal');
$routes->post('deleteCloudGoal', 'Platform\CloudNine::deleteCloudGoal');

前端AJAX提交代码 #

$('#newC9GoalForm').on('submit', function(event) {
        event.preventDefault();

        var form = new FormData(this);

        $.ajax({
            type: 'POST',
            url: '/createNewCloudGoal',
            data: form,
            contentType: false,
            processData: false,
            success: function(result) {
                $('#createNewC9Goal').modal('hide');

                var r = JSON.parse(result);
                if(r.ret === '1' || r.ret === 1) {
                    new Noty({
                        type: 'success',
                        theme: 'relax',
                        text: r.msg,
                        timeout: 2420,
                        callbacks: {
                            afterClose: function() {
                                window.location.href = window.location.href;
                            }
                        }
                    }).show();
                } else {
                    new Noty({
                        type: 'error',
                        theme: 'relax',
                        text: r.msg,
                        timeout: 2420
                    }).show();
                }
            },
            error: function(jqXHR, textStatus, errorThrown) {
                console.log(form.values);
                console.log(JSON.stringify(jqXHR));
                console.log("AJAX error: " + textStatus + ' : ' + errorThrown);
            }
        });
    });

异常现象 #

请求完全无法进入对应控制器逻辑，直接返回异常：

• 浏览器开发者工具Payload面板可正常展示FormData内的提交数据
• Response Preview面板为空白页
• 请求列表中状态码显示为500，双击该请求打开独立详情页时显示404错误页面

已排除的干扰项 #

• 基础代码结构问题：其余所有接口的AJAX请求均采用完全相同的代码结构，路由规则遵循统一配置规范，其他请求的根路径写法均正常运行，无需使用base_url()辅助函数拼接路径
• 请求头配置问题：尝试调整contentType参数的多种取值，均未解决问题
• 前端捕获的错误信息无有效排查线索，该问题直接阻塞项目开发进度

排查进展 #

查看框架系统日志后定位到相关报错，当时暂未找到对应修复方案，日志内容如下：

#8 {main}
ERROR - 2022-06-10 10:42:41 --> Unknown column 'complete' in 'where clause'
CRITICAL - 2022-06-10 10:42:47 --> syntax error, unexpected ';', expecting ']'
#0 .../system/Autoloader/Autoloader.php(241): CodeIgniter\Autoloader\Autoloader->includeFile('...')
#1 .../system/Autoloader/Autoloader.php(219): CodeIgniter\Autoloader\Autoloader->loadInNamespace('App\\Controllers...')
#2 [internal function]: CodeIgniter\Autoloader\Autoloader->loadClass('App\\Controllers...')
#3 [internal function]: spl_autoload_call('App\\Controllers...')
#4 .../system/CodeIgniter.php(789): class_exists('\\App\\Controller...', true)
#5 .../system/CodeIgniter.php(397): CodeIgniter\CodeIgniter->startController()
#6 .../system/CodeIgniter.php(318): CodeIgniter\CodeIgniter->handleRequest(NULL, Object(Config\Cache), false)
#7 .../index.php(37): CodeIgniter\CodeIgniter->run()

同目录下其余控制器均运行正常，当时未定位到该报错的触发原因。 #

最终根因与修复 #

顺着系统日志的调用栈逐层追踪，最终定位故障根源：几周前编写该控制器代码时，存在一处极易忽略的数组语法错误（多余分号、未闭合数组括号），导致控制器类无法被框架自动加载，路由匹配阶段直接抛出异常，请求根本无法进入控制器逻辑。修复该语法问题后，所有接口恢复正常。

同类问题排障提示：CodeIgniter 4的自动加载机制在加载控制器类时，如果类文件存在语法错误导致类无法被解析，会直接在路由调度阶段返回404/500混合错误，不会进入控制器内的业务代码。遇到同类单控制器路由404问题时，不要只盯着路由配置和前端请求写法，第一时间查看writable/logs下的框架日志，顺着调用栈排查类加载阶段的错误，效率远高于逐行核对路由和前端代码。

内容的提问来源于stack exchange，提问作者fangb0n3