mirror of
https://github.com/zhamao-robot/zhamao-framework.git
synced 2026-03-17 20:54:52 +08:00
72 lines
29 KiB
HTML
72 lines
29 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="en-US">
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
|
||
<title>配置 | 炸毛框架 v3</title>
|
||
<meta name="description" content="">
|
||
<meta name="generator" content="VuePress 1.9.10">
|
||
<link rel="icon" href="/logo_trans.png">
|
||
<script>
|
||
var _hmt = _hmt || [];
|
||
(function () {
|
||
var hm = document.createElement("script");
|
||
hm.src = "https://hm.baidu.com/hm.js?f0f276cefa10aa31a20ae3815a50b795";
|
||
var s = document.getElementsByTagName("script")[0];
|
||
s.parentNode.insertBefore(hm, s);
|
||
})();
|
||
</script>
|
||
<meta name="description" content="一个高性能聊天机器人 + Web 框架">
|
||
<link rel="preload" href="/assets/css/0.styles.de075592.css" as="style"><link rel="preload" href="/assets/js/app.cf958133.js" as="script"><link rel="preload" href="/assets/js/2.4c04991c.js" as="script"><link rel="preload" href="/assets/js/1.d8755a39.js" as="script"><link rel="preload" href="/assets/js/52.fe63ad16.js" as="script"><link rel="prefetch" href="/assets/js/10.960912c3.js"><link rel="prefetch" href="/assets/js/11.cd171694.js"><link rel="prefetch" href="/assets/js/12.ff9ca1d1.js"><link rel="prefetch" href="/assets/js/13.a56deac8.js"><link rel="prefetch" href="/assets/js/14.b222a011.js"><link rel="prefetch" href="/assets/js/15.31489867.js"><link rel="prefetch" href="/assets/js/16.e921dbc4.js"><link rel="prefetch" href="/assets/js/17.58f730d3.js"><link rel="prefetch" href="/assets/js/18.26c46c49.js"><link rel="prefetch" href="/assets/js/19.ee0bfd3b.js"><link rel="prefetch" href="/assets/js/20.bb3578b8.js"><link rel="prefetch" href="/assets/js/21.e66f7fe5.js"><link rel="prefetch" href="/assets/js/22.cba8ca48.js"><link rel="prefetch" href="/assets/js/23.cb49f41c.js"><link rel="prefetch" href="/assets/js/24.d95b175a.js"><link rel="prefetch" href="/assets/js/25.b0d69869.js"><link rel="prefetch" href="/assets/js/26.8e7089c0.js"><link rel="prefetch" href="/assets/js/27.333a53a1.js"><link rel="prefetch" href="/assets/js/28.df4b871c.js"><link rel="prefetch" href="/assets/js/29.5427ad45.js"><link rel="prefetch" href="/assets/js/3.07fc018e.js"><link rel="prefetch" href="/assets/js/30.7cb7445a.js"><link rel="prefetch" href="/assets/js/31.5c4bb546.js"><link rel="prefetch" href="/assets/js/32.7fc05474.js"><link rel="prefetch" href="/assets/js/33.9684a4f8.js"><link rel="prefetch" href="/assets/js/34.83e32a28.js"><link rel="prefetch" href="/assets/js/35.95d03df6.js"><link rel="prefetch" href="/assets/js/36.80aace42.js"><link rel="prefetch" href="/assets/js/37.1eaed2ee.js"><link rel="prefetch" href="/assets/js/38.75fa7a1c.js"><link rel="prefetch" href="/assets/js/39.117f5802.js"><link rel="prefetch" href="/assets/js/4.6623271b.js"><link rel="prefetch" href="/assets/js/40.57eba153.js"><link rel="prefetch" href="/assets/js/41.89c4a7c8.js"><link rel="prefetch" href="/assets/js/42.d8f92f99.js"><link rel="prefetch" href="/assets/js/43.5ee83631.js"><link rel="prefetch" href="/assets/js/44.c09b5b0c.js"><link rel="prefetch" href="/assets/js/45.bd850606.js"><link rel="prefetch" href="/assets/js/46.732b1cef.js"><link rel="prefetch" href="/assets/js/47.2a872d0d.js"><link rel="prefetch" href="/assets/js/48.959e18f4.js"><link rel="prefetch" href="/assets/js/49.a9bb32f7.js"><link rel="prefetch" href="/assets/js/5.073233e8.js"><link rel="prefetch" href="/assets/js/50.ca90a854.js"><link rel="prefetch" href="/assets/js/51.79142530.js"><link rel="prefetch" href="/assets/js/53.ed84845a.js"><link rel="prefetch" href="/assets/js/54.3ab7e492.js"><link rel="prefetch" href="/assets/js/55.9028e407.js"><link rel="prefetch" href="/assets/js/56.8173f798.js"><link rel="prefetch" href="/assets/js/57.2166b068.js"><link rel="prefetch" href="/assets/js/58.7c52b6bf.js"><link rel="prefetch" href="/assets/js/59.e9965a7b.js"><link rel="prefetch" href="/assets/js/60.f277436c.js"><link rel="prefetch" href="/assets/js/61.3712f8fe.js"><link rel="prefetch" href="/assets/js/8.899a0731.js"><link rel="prefetch" href="/assets/js/9.e2e8da12.js"><link rel="prefetch" href="/assets/js/vendors~docsearch.303532f0.js">
|
||
<link rel="stylesheet" href="/assets/css/0.styles.de075592.css">
|
||
</head>
|
||
<body>
|
||
<div id="app" data-server-rendered="true"><div class="theme-container"><header class="navbar"><div class="ant-row"><div class="nav-button"><i aria-label="icon: bars" class="anticon anticon-bars"><svg viewBox="0 0 1024 1024" focusable="false" data-icon="bars" width="1em" height="1em" fill="currentColor" aria-hidden="true"><path d="M912 192H328c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h584c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 284H328c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h584c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 284H328c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h584c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM104 228a56 56 0 1 0 112 0 56 56 0 1 0-112 0zm0 284a56 56 0 1 0 112 0 56 56 0 1 0-112 0zm0 284a56 56 0 1 0 112 0 56 56 0 1 0-112 0z"></path></svg></i> <span></span></div> <div class="ant-col ant-col-xs-24 ant-col-sm-24 ant-col-md-6 ant-col-lg-6 ant-col-xl-5 ant-col-xxl-4"><a href="/" class="router-link-active home-link"><img src="/logo_trans.png" alt="炸毛框架 v3" class="logo"> <span class="site-name">炸毛框架 v3</span></a> <div class="search-box mobile-search"><input aria-label="Search" autocomplete="off" spellcheck="false" value=""> <!----></div></div> <div class="nav-space-between ant-col ant-col-xs-0 ant-col-sm-0 ant-col-md-18 ant-col-lg-18 ant-col-xl-19 ant-col-xxl-20"><div class="search-box"><input aria-label="Search" autocomplete="off" spellcheck="false" value=""> <!----></div> <nav class="nav-links can-hide"><ul role="menu" id="nav" class="ant-menu ant-menu-horizontal ant-menu-root ant-menu-light"><li role="menuitem" class="ant-menu-submenu ant-menu-submenu-horizontal ant-menu-overflowed-submenu" style="display:none;"><div aria-haspopup="true" class="ant-menu-submenu-title"><span>···</span><i class="ant-menu-submenu-arrow"></i></div></li><li role="menuitem" class="ant-menu-item ant-menu-item-selected"><a href="/guide/" class="router-link-active">
|
||
指南
|
||
</a></li><li role="menuitem" class="ant-menu-submenu ant-menu-submenu-horizontal ant-menu-overflowed-submenu" style="display:none;"><div aria-haspopup="true" class="ant-menu-submenu-title"><span>···</span><i class="ant-menu-submenu-arrow"></i></div></li><li role="menuitem" class="ant-menu-item"><a href="/event/">
|
||
事件
|
||
</a></li><li role="menuitem" class="ant-menu-submenu ant-menu-submenu-horizontal ant-menu-overflowed-submenu" style="display:none;"><div aria-haspopup="true" class="ant-menu-submenu-title"><span>···</span><i class="ant-menu-submenu-arrow"></i></div></li><li role="menuitem" class="ant-menu-item"><a href="/components/bot/bot-context.html">
|
||
组件
|
||
</a></li><li role="menuitem" class="ant-menu-submenu ant-menu-submenu-horizontal ant-menu-overflowed-submenu" style="display:none;"><div aria-haspopup="true" class="ant-menu-submenu-title"><span>···</span><i class="ant-menu-submenu-arrow"></i></div></li><li role="menuitem" class="ant-menu-item"><a href="/plugins/management.html">
|
||
插件
|
||
</a></li><li role="menuitem" class="ant-menu-submenu ant-menu-submenu-horizontal ant-menu-overflowed-submenu" style="display:none;"><div aria-haspopup="true" class="ant-menu-submenu-title"><span>···</span><i class="ant-menu-submenu-arrow"></i></div></li><li role="menuitem" class="ant-menu-item"><a href="/advanced/">
|
||
进阶
|
||
</a></li><li role="menuitem" class="ant-menu-submenu ant-menu-submenu-horizontal ant-menu-overflowed-submenu" style="display:none;"><div aria-haspopup="true" class="ant-menu-submenu-title"><span>···</span><i class="ant-menu-submenu-arrow"></i></div></li><li role="menuitem" class="ant-menu-item"><a href="/update/v3.html">
|
||
更新日志
|
||
</a></li><li role="menuitem" class="ant-menu-submenu ant-menu-submenu-horizontal ant-menu-overflowed-submenu" style="display:none;"><div aria-haspopup="true" class="ant-menu-submenu-title"><span>···</span><i class="ant-menu-submenu-arrow"></i></div></li><li role="menuitem" class="ant-menu-item"><a href="/doxy/" target="_blank">
|
||
API 文档
|
||
<i aria-label="icon: link" class="anticon anticon-link"><svg viewBox="64 64 896 896" focusable="false" data-icon="link" width="1em" height="1em" fill="currentColor" aria-hidden="true"><path d="M574 665.4a8.03 8.03 0 0 0-11.3 0L446.5 781.6c-53.8 53.8-144.6 59.5-204 0-59.5-59.5-53.8-150.2 0-204l116.2-116.2c3.1-3.1 3.1-8.2 0-11.3l-39.8-39.8a8.03 8.03 0 0 0-11.3 0L191.4 526.5c-84.6 84.6-84.6 221.5 0 306s221.5 84.6 306 0l116.2-116.2c3.1-3.1 3.1-8.2 0-11.3L574 665.4zm258.6-474c-84.6-84.6-221.5-84.6-306 0L410.3 307.6a8.03 8.03 0 0 0 0 11.3l39.7 39.7c3.1 3.1 8.2 3.1 11.3 0l116.2-116.2c53.8-53.8 144.6-59.5 204 0 59.5 59.5 53.8 150.2 0 204L665.3 562.6a8.03 8.03 0 0 0 0 11.3l39.8 39.8c3.1 3.1 8.2 3.1 11.3 0l116.2-116.2c84.5-84.6 84.5-221.5 0-306.1zM610.1 372.3a8.03 8.03 0 0 0-11.3 0L372.3 598.7a8.03 8.03 0 0 0 0 11.3l39.6 39.6c3.1 3.1 8.2 3.1 11.3 0l226.4-226.4c3.1-3.1 3.1-8.2 0-11.3l-39.5-39.6z"></path></svg></i></a></li><li role="menuitem" class="ant-menu-submenu ant-menu-submenu-horizontal ant-menu-overflowed-submenu" style="display:none;"><div aria-haspopup="true" class="ant-menu-submenu-title"><span>···</span><i class="ant-menu-submenu-arrow"></i></div></li><li role="menuitem" class="ant-menu-item"><a href="https://docs-v2.zhamao.xin/" target="_blank">
|
||
炸毛框架 v2
|
||
<i aria-label="icon: link" class="anticon anticon-link"><svg viewBox="64 64 896 896" focusable="false" data-icon="link" width="1em" height="1em" fill="currentColor" aria-hidden="true"><path d="M574 665.4a8.03 8.03 0 0 0-11.3 0L446.5 781.6c-53.8 53.8-144.6 59.5-204 0-59.5-59.5-53.8-150.2 0-204l116.2-116.2c3.1-3.1 3.1-8.2 0-11.3l-39.8-39.8a8.03 8.03 0 0 0-11.3 0L191.4 526.5c-84.6 84.6-84.6 221.5 0 306s221.5 84.6 306 0l116.2-116.2c3.1-3.1 3.1-8.2 0-11.3L574 665.4zm258.6-474c-84.6-84.6-221.5-84.6-306 0L410.3 307.6a8.03 8.03 0 0 0 0 11.3l39.7 39.7c3.1 3.1 8.2 3.1 11.3 0l116.2-116.2c53.8-53.8 144.6-59.5 204 0 59.5 59.5 53.8 150.2 0 204L665.3 562.6a8.03 8.03 0 0 0 0 11.3l39.8 39.8c3.1 3.1 8.2 3.1 11.3 0l116.2-116.2c84.5-84.6 84.5-221.5 0-306.1zM610.1 372.3a8.03 8.03 0 0 0-11.3 0L372.3 598.7a8.03 8.03 0 0 0 0 11.3l39.6 39.6c3.1 3.1 8.2 3.1 11.3 0l226.4-226.4c3.1-3.1 3.1-8.2 0-11.3l-39.5-39.6z"></path></svg></i></a></li><li role="menuitem" class="ant-menu-submenu ant-menu-submenu-horizontal ant-menu-overflowed-submenu" style="visibility:hidden;position:absolute;"><div aria-haspopup="true" class="ant-menu-submenu-title"><span>···</span><i class="ant-menu-submenu-arrow"></i></div></li></ul> <ul class="extra-group"><li><a href="https://github.com/zhamao-robot/zhamao-framework" target="_blank" rel="noopener noreferrer" class="repo-link"><i aria-label="icon: github" class="anticon anticon-github"><svg viewBox="64 64 896 896" focusable="false" data-icon="github" width="1em" height="1em" fill="currentColor" aria-hidden="true"><path d="M511.6 76.3C264.3 76.2 64 276.4 64 523.5 64 718.9 189.3 885 363.8 946c23.5 5.9 19.9-10.8 19.9-22.2v-77.5c-135.7 15.9-141.2-73.9-150.3-88.9C215 726 171.5 718 184.5 703c30.9-15.9 62.4 4 98.9 57.9 26.4 39.1 77.9 32.5 104 26 5.7-23.5 17.9-44.5 34.7-60.8-140.6-25.2-199.2-111-199.2-213 0-49.5 16.3-95 48.3-131.7-20.4-60.5 1.9-112.3 4.9-120 58.1-5.2 118.5 41.6 123.2 45.3 33-8.9 70.7-13.6 112.9-13.6 42.4 0 80.2 4.9 113.5 13.9 11.3-8.6 67.3-48.8 121.3-43.9 2.9 7.7 24.7 58.3 5.5 118 32.4 36.8 48.9 82.7 48.9 132.3 0 102.2-59 188.1-200 212.9a127.5 127.5 0 0 1 38.1 91v112.5c.8 9 0 17.9 15 17.9 177.1-59.7 304.6-227 304.6-424.1 0-247.2-200.4-447.3-447.5-447.3z"></path></svg></i></a></li> <!----></ul></nav></div></div> <!----></header> <aside class="sidebar"><!----> <ul class="sidebar-links"><li><section class="sidebar-group depth-0"><p class="sidebar-heading open"><span>指南</span> <!----></p> <ul class="sidebar-links sidebar-group-items"><li><a href="/guide/" aria-current="page" title="介绍" class="sidebar-link">介绍</a></li><li><a href="/guide/installation.html" title="安装" class="sidebar-link">安装</a></li><li><a href="/guide/configuration.html" aria-current="page" title="配置" class="active sidebar-link">配置</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/guide/configuration.html#global-php-配置说明" title="global.php 配置说明" class="sidebar-link">global.php 配置说明</a></li><li class="sidebar-sub-header"><a href="/guide/configuration.html#配置文件格式" title="配置文件格式" class="sidebar-link">配置文件格式</a></li><li class="sidebar-sub-header"><a href="/guide/configuration.html#环境配置" title="环境配置" class="sidebar-link">环境配置</a></li><li class="sidebar-sub-header"><a href="/guide/configuration.html#访问配置项" title="访问配置项" class="sidebar-link">访问配置项</a></li><li class="sidebar-sub-header"><a href="/guide/configuration.html#环境变量" title="环境变量" class="sidebar-link">环境变量</a></li></ul></li><li><a href="/guide/structure.html" title="目录结构" class="sidebar-link">目录结构</a></li><li><a href="/guide/get-started.html" title="快速上手 - 聊天机器人" class="sidebar-link">快速上手 - 聊天机器人</a></li><li><a href="/guide/debugging.html" title="调试" class="sidebar-link">调试</a></li></ul></section></li></ul> </aside> <main class="page has-page-anchor"> <div class="theme-antdocs-content content__default"><h1 id="配置"><a href="#配置" class="header-anchor">#</a> 配置</h1> <p>炸毛框架的所有配置文件都存储在 <code>config/</code> 目录中。每个选项都带有文档，所以你可以查阅这些文件并熟悉可用的配置项。</p> <p>一般来说，我们建议你优先查看 <code>config/global.php</code> 文件及其文档，它包含了运行框架所需要的绝大部分配置，例如通信方式和时区等。</p> <h2 id="global-php-配置说明"><a href="#global-php-配置说明" class="header-anchor">#</a> global.php 配置说明</h2> <p>此处仅说明 <code>global.php</code> 当中较为重要的 <code>driver</code> 和 <code>servers</code> 配置项，其他配置项请参考 <code>config/global.php</code> 文件的注释。</p> <div class="language-php line-numbers-mode"><pre class="language-php"><code><span class="token comment">/* 启动框架的底层驱动（原生支持 swoole、workerman 两种） */</span>
|
||
<span class="token variable">$config</span><span class="token punctuation">[</span><span class="token string single-quoted-string">'driver'</span><span class="token punctuation">]</span> <span class="token operator">=</span> <span class="token function">env</span><span class="token punctuation">(</span><span class="token string single-quoted-string">'DRIVER'</span><span class="token punctuation">,</span> <span class="token string single-quoted-string">'workerman'</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
|
||
<span class="token comment">/* 要启动的服务器监听端口及协议 */</span>
|
||
<span class="token variable">$config</span><span class="token punctuation">[</span><span class="token string single-quoted-string">'servers'</span><span class="token punctuation">]</span> <span class="token operator">=</span> <span class="token punctuation">[</span>
|
||
<span class="token punctuation">[</span>
|
||
<span class="token string single-quoted-string">'host'</span> <span class="token operator">=></span> <span class="token string single-quoted-string">'0.0.0.0'</span><span class="token punctuation">,</span>
|
||
<span class="token string single-quoted-string">'port'</span> <span class="token operator">=></span> <span class="token number">20001</span><span class="token punctuation">,</span>
|
||
<span class="token string single-quoted-string">'type'</span> <span class="token operator">=></span> <span class="token string single-quoted-string">'websocket'</span><span class="token punctuation">,</span>
|
||
<span class="token punctuation">]</span><span class="token punctuation">,</span>
|
||
<span class="token punctuation">[</span>
|
||
<span class="token string single-quoted-string">'host'</span> <span class="token operator">=></span> <span class="token string single-quoted-string">'0.0.0.0'</span><span class="token punctuation">,</span>
|
||
<span class="token string single-quoted-string">'port'</span> <span class="token operator">=></span> <span class="token number">20002</span><span class="token punctuation">,</span>
|
||
<span class="token string single-quoted-string">'type'</span> <span class="token operator">=></span> <span class="token string single-quoted-string">'http'</span><span class="token punctuation">,</span>
|
||
<span class="token string single-quoted-string">'flag'</span> <span class="token operator">=></span> <span class="token number">20002</span><span class="token punctuation">,</span>
|
||
<span class="token punctuation">]</span><span class="token punctuation">,</span>
|
||
<span class="token punctuation">]</span><span class="token punctuation">;</span>
|
||
</code></pre> <div class="line-numbers-wrapper"><span class="line-number">1</span><br><span class="line-number">2</span><br><span class="line-number">3</span><br><span class="line-number">4</span><br><span class="line-number">5</span><br><span class="line-number">6</span><br><span class="line-number">7</span><br><span class="line-number">8</span><br><span class="line-number">9</span><br><span class="line-number">10</span><br><span class="line-number">11</span><br><span class="line-number">12</span><br><span class="line-number">13</span><br><span class="line-number">14</span><br><span class="line-number">15</span><br><span class="line-number">16</span><br><span class="line-number">17</span><br></div></div><h3 id="driver"><a href="#driver" class="header-anchor">#</a> driver</h3> <p><code>driver</code> 配置项用于指定框架的底层驱动，目前支持以下驱动：</p> <ul><li><code>swoole</code>：基于 Swoole，需要安装 <code>swoole</code> 扩展，协程支持很好</li> <li><code>workerman</code>：基于 Workerman，无需安装额外扩展，但在 PHP 8.0 下无法使用协程</li> <li><code>choir</code>：基于 Choir，尚未完成，不建议使用</li></ul> <h3 id="servers"><a href="#servers" class="header-anchor">#</a> servers</h3> <p><code>servers</code> 配置项用于指定框架的服务器（<a href="https://12.onebot.dev/connect/" target="_blank" rel="noopener noreferrer">通信方式<span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></a>）配置，目前支持以下服务器：</p> <ul><li><code>http</code>：基础的 HTTP 服务（监听传入的 HTTP 请求）
|
||
<ul><li><code>host</code>：监听地址</li> <li><code>port</code>：监听端口</li> <li><code>flags</code>：一个 int 值，用于在事件中获取源于哪一个 HTTP 监听的地址和端口</li></ul></li> <li><code>websocket</code>：WebSocket 服务（允许其他客户端接入）
|
||
<ul><li><code>host</code>：监听地址</li> <li><code>port</code>：监听端口</li> <li><code>flags</code>：同上方 HTTP 的 <code>flags</code></li></ul></li></ul> <p>以上所有服务器均支持 <code>access_token</code> 配置项，用于指定<a href="/components/bot/authorization.html">鉴权方式</a>。</p> <hr> <h2 id="配置文件格式"><a href="#配置文件格式" class="header-anchor">#</a> 配置文件格式</h2> <p>除了 <code>php</code> 文件外，我们还支持以下格式：</p> <ul><li>YAML</li> <li>JSON</li> <li>TOML</li></ul> <h2 id="环境配置"><a href="#环境配置" class="header-anchor">#</a> 环境配置</h2> <p>根据运行的环境采用不同的配置值是很有必要的，例如你可能希望在本地和生产环境中使用不同的数据库配置。</p> <p>为了方便这一功能，我们提供了基于环境的配置加载措施。你可以在启动框架时使用 <code>--env</code>
|
||
选项指定当前环境，例如 <code>./zhamao server --env=production</code> 。</p> <p>如果未明确指定当前环境，则默认环境为 <code>development</code>。</p> <p>如果要使某一配置文件只在特定环境下记载，你可以为给文件添加后缀，例如 <code>example.production.php</code>
|
||
只会在当前环境为 <code>production</code> 时加载。</p> <p>你可以同时设置基础配置文件和环境特定配置文件，例如 <code>global.php</code> 和 <code>global.production.php</code> ，后者将会覆盖前者中的配置项。</p> <h3 id="配置安全"><a href="#配置安全" class="header-anchor">#</a> 配置安全</h3> <p>我们<strong>非常不建议</strong>你将数据库信息、访问密钥的敏感字段提交给版本控制，因为这可能会导致相关信息的泄露，同时也不利于其他开发人员修改自己的本地配置。</p> <p>相反，我们建议你借助 DotEnv 等库，将相关配置信息写入 <code>.env</code> 文件中，并按需读取。</p> <p>你可以选择使用下方的环境变量来区分不同环境的配置，并提高安全性。</p> <h2 id="访问配置项"><a href="#访问配置项" class="header-anchor">#</a> 访问配置项</h2> <p>你可以在任何地方使用全局 <code>config()</code> 函数获取配置项值。支持使用点语法获取，配置项名称由文件名开头，并允许指定默认值。</p> <div class="language-php line-numbers-mode"><pre class="language-php"><code><span class="token comment"># 获取时区，未设置则返回 Asia/Shanghai</span>
|
||
<span class="token variable">$value</span> <span class="token operator">=</span> <span class="token function">config</span><span class="token punctuation">(</span><span class="token string single-quoted-string">'global.runtime.timezone'</span><span class="token punctuation">,</span> <span class="token string single-quoted-string">'Asia/Shanghai'</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
</code></pre> <div class="line-numbers-wrapper"><span class="line-number">1</span><br><span class="line-number">2</span><br></div></div><p>你也可以使用 <code>config</code> 函数设置配置项，传递数组即可：</p> <div class="language-php line-numbers-mode"><pre class="language-php"><code><span class="token comment"># 将时区修改为 UTC</span>
|
||
<span class="token function">config</span><span class="token punctuation">(</span><span class="token punctuation">[</span><span class="token string single-quoted-string">'global.runtime.timezone'</span> <span class="token operator">=></span> <span class="token string single-quoted-string">'UTC'</span><span class="token punctuation">]</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
</code></pre> <div class="line-numbers-wrapper"><span class="line-number">1</span><br><span class="line-number">2</span><br></div></div><h2 id="环境变量"><a href="#环境变量" class="header-anchor">#</a> 环境变量</h2> <p>在不同的环境中使用不同的配置是很有必要的，例如你可能希望在本地和生产环境中使用不同的数据库配置。</p> <p>然而，你可能不希望将这些敏感信息（例如生产环境的密钥、数据库配置等）提交到版本控制中，因此我们提供了基于环境变量的配置加载措施。</p> <p>简单来说，你可以在 <code>.env</code> 文件中设置环境变量，然后在配置文件中使用 <code>env()</code> 函数获取环境变量的值。</p> <p>需要注意的是，<code>.env</code> 文件中的所有变量均可被外部环境变量覆盖（例如系统级或 Docker 等容器环境变量）。</p> <div class="custom-block warning"><p class="custom-block-title">注意</p> <p>我们<strong>强烈不建议</strong>你将 <code>.env</code> 文件提交到版本控制中，因为这可能会导致相关信息的泄露，同时也不利于其他开发人员修改自己的本地配置。</p> <p>我们建议你将 <code>.env</code> 文件添加到 <code>.gitignore</code> 中，或者使用其他方式（例如 Doppler 等服务或是 Docker 等容器）来管理环境变量。</p> <p>你可以通过保留 <code>.env.example</code> 文件来提供其他开发人员参考。</p></div> <h3 id="环境变量类型转换"><a href="#环境变量类型转换" class="header-anchor">#</a> 环境变量类型转换</h3> <p>环境变量默认都是字符串类型，但框架内部会自动将其转换为其他类型以便使用，转换表格如下：</p> <table><thead><tr><th>原始值</th> <th style="text-align:center;">转换后</th></tr></thead> <tbody><tr><td><code>true</code></td> <td style="text-align:center;"><code>true</code></td></tr> <tr><td><code>(true)</code></td> <td style="text-align:center;"><code>true</code></td></tr> <tr><td><code>false</code></td> <td style="text-align:center;"><code>false</code></td></tr> <tr><td><code>(false)</code></td> <td style="text-align:center;"><code>false</code></td></tr> <tr><td><code>null</code></td> <td style="text-align:center;"><code>null</code></td></tr> <tr><td><code>(null)</code></td> <td style="text-align:center;"><code>null</code></td></tr> <tr><td><code>empty</code></td> <td style="text-align:center;"><code>''</code></td></tr></tbody></table></div> <footer class="page-edit"><div class="edit-link"><a href="https://github.com/zhamao-robot/zhamao-framework/edit/main/docs/guide/configuration.md" target="_blank" rel="noopener noreferrer">Edit this page</a> <span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></div> <!----></footer> <div class="page-nav"><p class="inner"><span class="prev"><a href="/guide/installation.html" class="prev"><i aria-label="icon: left" class="anticon anticon-left"><svg viewBox="64 64 896 896" focusable="false" data-icon="left" width="1em" height="1em" fill="currentColor" aria-hidden="true"><path d="M724 218.3V141c0-6.7-7.7-10.4-12.9-6.3L260.3 486.8a31.86 31.86 0 0 0 0 50.3l450.8 352.1c5.3 4.1 12.9.4 12.9-6.3v-77.3c0-4.9-2.3-9.6-6.1-12.6l-360-281 360-281.1c3.8-3 6.1-7.7 6.1-12.6z"></path></svg></i>
|
||
安装
|
||
</a></span> <span class="next"><a href="/guide/structure.html">
|
||
目录结构
|
||
<i aria-label="icon: right" class="anticon anticon-right"><svg viewBox="64 64 896 896" focusable="false" data-icon="right" width="1em" height="1em" fill="currentColor" aria-hidden="true"><path d="M765.7 486.8L314.9 134.7A7.97 7.97 0 0 0 302 141v77.3c0 4.9 2.3 9.6 6.1 12.6l360 281.1-360 281.1c-3.9 3-6.1 7.7-6.1 12.6V883c0 6.7 7.7 10.4 12.9 6.3l450.8-352.1a31.96 31.96 0 0 0 0-50.4z"></path></svg></i></a></span></p></div> <div class="page-anchor"><div class="ant-space ant-space-vertical" style="width:100%;"><div class="ant-space-item"><div class="page-anchor-offset"><div><div class="ant-anchor-wrapper" style="max-height:100vh;"><div class="ant-anchor"><div class="ant-anchor-ink"><span class="ant-anchor-ink-ball"></span></div><div class="ant-anchor-link"><a href="#global-php-配置说明" title="global.php 配置说明" class="ant-anchor-link-title">global.php 配置说明</a><div class="ant-anchor-link"><a href="#driver" title="driver" class="ant-anchor-link-title">driver</a></div><div class="ant-anchor-link"><a href="#servers" title="servers" class="ant-anchor-link-title">servers</a></div></div><div class="ant-anchor-link"><a href="#配置文件格式" title="配置文件格式" class="ant-anchor-link-title">配置文件格式</a></div><div class="ant-anchor-link"><a href="#环境配置" title="环境配置" class="ant-anchor-link-title">环境配置</a><div class="ant-anchor-link"><a href="#配置安全" title="配置安全" class="ant-anchor-link-title">配置安全</a></div></div><div class="ant-anchor-link"><a href="#访问配置项" title="访问配置项" class="ant-anchor-link-title">访问配置项</a></div><div class="ant-anchor-link"><a href="#环境变量" title="环境变量" class="ant-anchor-link-title">环境变量</a><div class="ant-anchor-link"><a href="#环境变量类型转换" title="环境变量类型转换" class="ant-anchor-link-title">环境变量类型转换</a></div></div></div></div></div></div></div></div></div> </main> <!----></div><div class="global-ui"></div></div>
|
||
<script src="/assets/js/app.cf958133.js" defer></script><script src="/assets/js/2.4c04991c.js" defer></script><script src="/assets/js/1.d8755a39.js" defer></script><script src="/assets/js/52.fe63ad16.js" defer></script>
|
||
</body>
|
||
</html> |