编辑文档 更新于

网站托管开发指南 · PHP

网站托管是云引擎的一个子模块，允许你用 PHP 开发一个 Web 程序，提供云函数和 Hook，还可以提供静态文件的托管和自定义的路由、绑定你自己的域名。你可以用它为你的移动应用提供一个介绍和下载页、开发一个管理员控制台或完整的网站，或者运行一些必须在服务器端运行的自定义逻辑。

如果你还不知道如何创建云引擎项目，本地调试并部署到云端，可以先阅读一下 云引擎快速入门。其他相关文档包括：

这篇文档以 PHP 为例，但云引擎还支持其他多种语言，你可以选择自己熟悉的技术栈进行开发：

项目骨架

你的项目需要遵循一定格式才会被云引擎识别并运行。

云引擎 PHP 项目必须有 $PROJECT_DIR/public/index.php 文件，该文件为整个项目的启动文件。

PHP 云引擎目前只提供了 5.5 版本。

本地运行和调试

使用 composer 安装第三方依赖：

composer install

接下来便可以在项目目录，用我们的命令行工具来启动本地调试了：

lean up

更多有关命令行工具和本地调试的内容请参考 命令行工具使用指南。

Web 框架

云引擎 PHP 不依赖第三方框架，你可以使用你最熟悉的框架进行开发，或者 不使用任何框架。但是请保证通过执行 public/index.php 能够启动你的项目。

LeanCloud SDK

云引擎使用 LeanCloud PHP SDK ，实际包含了存储 SDK，可以直接使用相关接口来存储数据。请参考 PHP 存储文档。

如果使用项目框架作为基础开发，LeanCloud PHP SDK 默认提供了支持 Slim 框架的中间件，可以根据示例程序的方式直接使用。

如果是自定义项目，则需要自己配置：

composer require leancloud/leancloud-sdk
  • 初始化：在正式使用数据存储之前，你需要使用自己的应用 key 进行初始化中间件：
use \LeanCloud\Client;

Client::initialize(
    getenv("LC_APP_ID"),          // 从 LC_APP_ID 这个环境变量中获取应用 app id 的值
    getenv("LC_APP_KEY"),         // 从 LC_APP_KEY 这个环境变量中获取应用 app key 的值
    getenv("LC_APP_MASTER_KEY")   // 从 LC_APP_MASTER_KEY 这个环境变量中获取应用 master key 的值
);

// 如果不希望使用 masterKey 权限，可以将下面一行删除
Client::useMasterKey(true);

健康监测

你的应用在启动时，云引擎的管理程序会每秒去检查你的应用是否启动成功，如果 30 秒 仍未启动成功，即认为启动失败；在之后应用正常运行的过程中，也会有定期的「健康监测」，以确保你的应用正常运行，如果健康监测失败，云引擎管理程序会自动重启你的应用。

健康检查的 URL 包括你的应用首页（/）和 PHP SDK 负责处理的 /__engine/1/ping，只要 两者之一 返回了 HTTP 200 的响应，就视作成功。因此请确保你的程序使用了 PHP SDK，或你的应用 首页能够正常地返回 HTTP 200 响应。

除此之外，为了支持云引擎的云函数和 Hook 功能，管理程序会使用 /1.1/functions/_ops/metadatas 这个 URL 和 PHP SDK 交互，请确保将这个 URL 交给 PHP SDK 处理，或 返回一个 HTTP 404 表示不使用云函数 和 Hook 相关的功能。

LeanCloud PHP SDK 内置了该 URL 的处理，只需要将中间件添加到请求的处理链路中即可：

$engine = new SlimEngine();
$app->add($engine);

如果未使用 LeanCloud PHP SDK，则需要自己实现该 URL 的处理，比如这样：

// 健康监测 router
$app->get('/__engine/1/ping', function($req, $res) {
    // PSR-7 response is immutable
    $response = $res->withHeader("Content-Type", "application/json");
    $response->getBody()->write(json_encode(array(
        "runtime" => "php-5.5",
        "version" => "custom"
    )));
    return $response;
});

// 云函数列表
app.get('/1.1/_ops/functions/metadatas', function(req, res) {
    $response = $res->withHeader("Content-Type", "application/json");
    $response->getBody()->write(json_encode(array(
        "result" => array()
    )));
    return $response;
});

部署

命令行部署

在你的项目根目录运行：

lean deploy

使用命令行工具可以非常方便地部署、发布应用，查看应用状态，查看日志，甚至支持多应用部署。具体使用请参考 命令行工具指南。

Git 部署

除此之外，还可以使用 git 仓库部署。你需要将项目提交到一个 git 仓库，我们并不提供源码的版本管理功能，而是借助于 git 这个优秀的分布式版本管理工具。我们推荐你使用 GitHub、Coding 或者 OSChina 这样第三方的源码托管网站，也可以使用你自己搭建的 git 仓库（比如 Gitlab）。

你需要先在这些平台上创建一个项目（如果已有代码，请不需要选择「Initialize this repository with a README」），在网站的个人设置中填写本地机器的 SSH 公钥（以 GitHub 为例，在 Settings => SSH and GPG keys 中点击 New SSH key），然后在项目目录执行：

git remote add origin git@github.com:<username>/<repoName>.git
git push -u origin master

然后到云引擎的设置界面填写你的 Git 仓库地址，如果是公开仓库建议填写 https 地址，例如 https://github.com/<username>/<repoName>.git。

如果是私有仓库需要填写 ssh 地址 git@github.com:<username>/<repoName>.git，还需要你将云引擎分配给你的公钥填写到第三方托管平台的 Deploy keys 中，以 GitHub 为例，在项目的 Settings => Deploy keys 中点击 Add deploy key。

设置好之后，今后需要部署代码时就可以在云引擎的部署界面直接点击「部署」了，默认会部署 master 分支的代码，你也可以在部署时填写分支、标签或具体的 Commit。

预备环境和生产环境

默认情况，云引擎只有一个「生产环境」，对应的域名是 {应用的域名}.leanapp.cn。在生产环境中有一个「体验实例」来运行应用。

当生产环境的体验实例升级到「标准实例」后会有一个额外的「预备环境」，对应域名 stg-{应用的域名}.leanapp.cn，两个环境所访问的都是同样的数据，你可以用预备环境测试你的云引擎代码，每次修改先部署到预备环境，测试通过后再发布到生产环境；如果你希望有一个独立数据源的测试环境，建议单独创建一个应用。

如果访问云引擎遇到「No Application Configured」的错误，通常是因为对应的环境还没有部署代码。例如应用可能没有预备环境，或应用尚未发布代码到生产环境。

有些时候你可能需要知道当前云引擎运行在什么环境（开发环境、预备环境或生产环境），从而做不同的处理：

$env = getenv("LEANCLOUD_APP_ENV");
if ($env === "development") {
    // 当前环境为「开发环境」，是由命令行工具启动的
} else if ($env === "production") {
    // 当前环境为「生产环境」，是线上正式运行的环境
} else {
    // 当前环境为「预备环境」
}

在客户端 SDK 调用云函数时，可以通过 REST API 的特殊的 HTTP 头 X-LC-Prod 来区分调用的环境。

  • X-LC-Prod: 0 表示调用预备环境
  • X-LC-Prod: 1 表示调用生产环境
客户端 SDK 都有类似于 setProduction 的方法，比如 JavaScript SDK API 的 AV.setProduction(production)，其中 production 设置为 0 则该 SDK 将请求预备环境；设置为 1 将请求生产环境，默认为 1。

设置域名

你可以在 云引擎 > 设置 的「Web 主机域名」部分，填写一个自定义的二级域名，例如你设置了 myapp，那么你就可以通过我们的二级域名来访问你的网站了：

  • http://myapp.leanapp.cn（中国区）
  • http://myapp.avosapps.us（美国区）
DNS 可能需要等待几个小时后才能生效。

用户状态管理

云引擎提供了一个 LeanCloud\Storage\CookieStorage 模块，用 Cookie 来维护用户（User）的登录状态，要使用它可以在 app.php 中添加下列代码：

use \LeanCloud\Storage\CookieStorage;
// 将会话状态存储到 cookie 中
Client::setStorage(new CookieStorage(60 * 60 * 24, "/"));

CookieStorage 支持传入秒作为过期时间, 以及路径作为 cookie 的作用域。默认过期时间为 7 天。然后我们可以通过 User::getCurrentUser() 来获取当前登录用户。

你可以这样简单地实现一个具有登录功能的站点：

$app->get('/login', function($req, $res) {
  // 渲染登录页面
});

// 处理登录请求（可能来自登录界面中的表单）
$app->post('/login', function($req, $res) {
    $params = $req->getQueryParams();
    try {
        User::logIn($params["username"], $params["password"]);
        // 跳转到个人资料页面
        return $res->withRedirect('/profile');
    } catch (Exception $ex) {
        //登录失败，跳转到登录页面
        return $res->withRedirect('/login');
    }
});

// 查看个人资料
$app->get('/profile', function($req, $res) {
    // 判断用户是否已经登录
    $user = User::getCurrentUser();
    if ($user) {
        // 如果已经登录，发送当前登录用户信息。
        return $res->getBody()->write($user->getUsername());
    } else {
        // 没有登录，跳转到登录页面。
        return $res->withRedirect('/login');
    }
});

// 登出账号
$app->get('/logout', function($req, $res) {
    User::logOut();
    return $res->redirect("/");
});

一个简单的登录页面可以是这样：

<html>
    <head></head>
    <body>
      <form method="post" action="/login">
        <label>Username</label>
        <input name="username"></input>
        <label>Password</label>
        <input name="password" type="password"></input>
        <input class="button" type="submit" value="登录">
      </form>
    </body>
  </html>

实现常见功能

发送 HTTP 请求

云引擎 PHP 环境可以使用内置的 curl 模块，不过我们推荐使用 guzzle 等第 三方库来处理 HTTP 请求。

安装 guzzle:

composer require guzzlehttp/guzzle:~6.0

代码示例：

$client = new GuzzleHttp\Client();
$resp = $client->post("http://www.example.com/create_post", array(
    "json" => array(
        "title" => "Vote for Pedro",
        "body"  => "If you vote for Pedro, your wildest dreams will come true"
    )
));

获取客户端 IP

如果你想获取客户端的 IP，可以直接从用户请求的 HTTP 头的 x-real-ip 字段获取，示例代码如下：

$app->get('/', function($req, $res) {
  error_log($_SERVER['HTTP_X_REAL_IP]); // 打印用户 IP 地址
  return $res;
});

文件上传

托管在 云引擎 的网站项目可以直接使用内置的 LeanCloud PHP SDK 的 API 文件相关的接口直接处理文件的上传。

假设前端 HTML 代码如下：

<form enctype="multipart/form-data" method="post" action="/upload">
  <input type="file" name="iconImage">
  <input type="submit" name="submit" value="submit">
</form>

接下来定义文件上传的处理函数，构建一个 Form 对象，并将 req 作为参数进行解析，会将请求中的文件保存到临时文件目录，并构造 files 对象：

$app->post("/upload", function($req, $res) {
    if (isset($_FILES["iconImage"]) && $_FILES["iconImage"]["size"] != 0) {
        $file = File::createWithLocalFile(
            $_FILES["iconImage"]["tmp_name"],
            $_FILES["iconImage"]["type"]
        );
        $file->save();
        $res->getBody()->write("文件上传成功");
    } else {
        $res->getBody()->write("请选择一个文件");
    }
});

Session

有时候你需要将一些自己需要的属性保存在会话中，我们建议使用 CookieStorage 来保存：

// 在项目启动时启用 CookieStorage
Client::setStorage(new CookieStorage());

// 在项目中可以使用 CookieStorage 存储属性
$cookieStorage = Client::getStorage();
$cookieStorage->set("key", "val");

注意：PHP 默认的 $_SESSION 在我们云引擎中是无法正常工作的，因为我们 的云引擎是多主机、多进程运行，因此内存型 session 是无法共享的。建议用 CookieStorage 来存储会话信息。

LeanCache

关于 LeanCache 的更多使用方法请看 LeanCache 使用指南。

重定向到 HTTPS

为了安全性，我们可能会为网站加上 HTTPS 加密传输。我们的 云引擎 支持网站托管，同样会有这样的需求。

因此我们在 云引擎 中提供了一个新的 middleware 来强制让你的 {应用的域名}.leanapp.cn 的网站通过 https 访问，你只要这样：

SlimEngine::enableHttpsRedirect();
$app->add(new SlimEngine());

部署并发布到生产环境之后，访问你的 云引擎 网站二级域名都会强制通过 HTTPS 访问。

线上环境

环境变量

云引擎平台默认提供下列环境变量供应用使用：

变量名 说明
LEANCLOUD_APP_ID 当前应用的 App Id
LEANCLOUD_APP_KEY 当前应用的 App Key
LEANCLOUD_APP_MASTER_KEY 当前应用的 Master Key
LEANCLOUD_APP_ENV 当前的应用环境：
  • 开发环境没有该环境变量，或值为 development（一般指本地开发）
  • 预备环境值为 stage
  • 生产环境值为 production
LEANCLOUD_APP_PORT 当前应用开放给外网的端口，只有监听此端口，用户才可以访问到你的服务。
LEANCLOUD_APP_INSTANCE 云引擎实例名称，在多实例环境可以通过此变量标示自己。
LEANCLOUD_API_SERVER 访问存储服务时使用的地址（类似于 https://api.leancloud.cn）。该值会因为所在数据中心等原因导致不一样，所以使用 REST API 请求存储服务或 LeanCloud 其他服务时请使用此环境变量的值。在云引擎中不要直接使用 https://api.leancloud.cn。
LEANCLOUD_AVAILABLE_CPUS 云引擎实例可用 CPU 的数量，高规格实例（如：2CPU 1024MB 内存）时该值大于 1。应用可以根据该值启动对应数量的线程或者进程。在云引擎中不要直接使用操作系统 CPU 核数，否则可能启动过多的进程导致超出实例规格而异常退出。
LEANCLOUD_APP_GROUP 云引擎实例所在的组。当使用云引擎 组管理 功能时，该值为组的名称。
LEANCLOUD_REGION 云引擎服务所在区域，值为 CN 或 US，分别表示国内节点和美国节点。
旧版云引擎使用的以 LC_ 开头的环境变量（如 LC_APP_ID）已经被弃用。为了保证代码兼容性，LC_ 变量在一段时间内依然有效，但未来可能会完全失效。为了避免报错，建议使用 LEANCLOUD_ 变量来替换。

你也可以在 云引擎 > 设置 > 自定义环境变量 页面中添加自定义的环境变量。其中名字必须是字母、数字、下划线且以字母开头，值必须是字符串，修改环境变量后会在下一次部署时生效。

按照一般的实践，可以将一些配置项存储在环境变量中，这样可以在不修改代码的情况下，修改环境变量并重新部署，来改变程序的行为；或者可以将一些第三方服务的 Secret Key 存储在环境变量中，避免这些密钥直接出现在代码中。

云引擎运行环境默认提供的环境变量，无法被自定义环境变量覆盖（覆盖无效）。

日志

在控制台的 云引擎 / 日志 中可以查看云引擎的部署和运行日志，还可以通过日志级别进行筛选。

应用的日志可以直接输出到「标准输出」或者「标准错误」，这些信息会分别对应日志的 info 和 error 级别，比如下列代码会在 info 级别记录参数信息：

Cloud::define("logSomething", function($params, $user) {
    error_log(json_encode($params));
});
日志单行最大 4096 个字符，多余部分会被丢弃；日志输出频率大于 600 行/分钟，多余的部分会被丢弃。

时区

在云引擎的中国区系统默认使用北京时间（Asia/Shanghai），美国区默认使用 UTC 时间。

依赖缓存

云引擎实现了一个缓存机制来加快构建的速度，所谓构建就是指你的应用在云引擎上安装依赖的过程，目测存在两种机制。

Node.js、Java 采用的：如果 package.json 或 pom.xml 和上次构建相比没有修改，就直接采用上次安装的依赖，只将新的应用代码替换上去。

Python、PHP 采用的：每次构建结束时将依赖目录打包，下次构建时将上次的依赖包解压到原处，再运行包管理器来安装依赖，可以复用已有的依赖项。

如果你遇到了与依赖安装有关的问题，可以在控制台部署时勾选「下载最新依赖」，或通过命令行工具部署时添加 --noCache 选项。

备案和自定义域名

如果需要绑定自己的域名，进入 应用控制台 > 账号设置 > 域名绑定，按照步骤填写资料即可。

国内节点绑定独立域名需要有 ICP 备案，美国节点不需要。

只有主域名需要备案，二级子域名不需要备案；如果没有 ICP 备案，请进入 应用控制台 > 账号设置 > 域名备案，按照步骤填写资料进行备案。

备案之前要求云引擎已经部署，并且网站内容和备案申请的内容一致。仅使用云引擎托管静态文件、未使用其他 LeanCloud 服务的企业用户，需要自行完成域名备案工作。
{{allComment[version]}} ×
  • 暂无评论
  • {{comment.author}}
    {{ comment.createdAt | date: 'yyyy-MM-dd HH:mm:ss '}}
    {{comment.content}}
您需要 后才能评论