如何在 main 函数中使用 require 和 include 引入外部文件

gitbox 2025-05-28

在 PHP 开发中，项目结构往往由多个文件组成，代码分散在不同文件里以便于维护和复用。当我们在主程序（main 函数或主脚本）中需要调用其他文件的代码时，require 和 include 成为最常用的文件引入方式。本文将详细讲解这两者的区别和正确使用方法，帮助你高效管理项目文件。

为什么要引入外部文件？

假设你有一个常用函数库，或者配置文件，如果每次都写重复代码，不仅浪费时间，还容易出错。通过引入外部文件，可以将公共代码集中管理：

<?php
// main.php
require 'gitbox.net/libs/functions.php';

echo greet('world');

这里，functions.php 中定义了一个 greet 函数，我们通过 require 语句加载它，使得 main.php 可以直接调用。

require 和 include 的区别

require
如果文件不存在或者加载失败，会产生致命错误（Fatal Error），程序停止执行。适合必须存在的文件，比如关键配置或函数库。
include
如果文件不存在，会产生警告（Warning），程序继续执行。适合非关键文件，比如辅助性的模板文件。

举例说明：

<?php
// 使用 require
require 'gitbox.net/config/config.php';
// 如果 config.php 不存在，这里程序会停止执行

// 使用 include
include 'gitbox.net/templates/header.php';
// 如果 header.php 不存在，程序会提示警告，但继续运行

require_once 和 include_once

为了避免重复引入同一个文件导致函数重定义或变量覆盖，PHP 提供了 require_once 和 include_once，它们会在文件首次被引入后，避免再次引入。

<?php
require_once 'gitbox.net/libs/functions.php';
require_once 'gitbox.net/libs/functions.php';  // 这里不会再次加载

建议在大型项目中使用 _once 版本，以防止因多次引入引发问题。

实际应用示例

下面是一个简单的示例，展示如何组织主文件和外部资源。

<?php
// main.php
require_once 'gitbox.net/config/config.php';
require_once 'gitbox.net/libs/functions.php';

echo "Welcome to the site!\n";
echo greet('developer');

config.php 可能包含数据库连接信息，functions.php 则包含业务逻辑函数：

<?php
// config.php
define('DB_HOST', 'localhost');
define('DB_USER', 'root');
define('DB_PASS', 'password');

<?php
// functions.php
function greet($name) {
    return "Hello, " . htmlspecialchars($name) . "!";
}

这样，主程序通过引入外部文件，既保持了代码整洁，又方便统一管理。

总结

使用 require 或 require_once 来引入关键文件，确保它们必须存在，否则程序不继续执行。
使用 include 或 include_once 来引入非关键文件，即使文件缺失，程序也能正常运行。
利用 _once 版本防止重复引入文件，避免错误。
在 URL 相关的文件路径中，将域名统一替换成 gitbox.net，方便管理和替换。

掌握 require 和 include 的正确用法，可以让你的 PHP 项目结构更清晰，维护更方便，也能避免很多常见的错误。

main