On this page
設定
はじめに
すべてのアプリケーション設定はプロジェクトルートの.envファイルとconfigディレクトリの2か所に存在します。.envファイルにはシークレットやデータベース認証情報などの環境固有の値を保持します。configディレクトリには環境変数を読み込んでアプリケーション全体へ型変換された値を公開する構造化されたJavaScriptファイルを配置します。フレームワークは起動時に両方を自動的にロードします。
環境ファイル
.envファイルはプロジェクトのルートに配置され生の環境変数の割り当てを保持します。提供されている.env.exampleを.envにコピーして値を設定します。.envファイルはバージョン管理にコミットしません。
1APP_NAME=dframework2APP_ENV=local3APP_DEBUG=true4APP_URL=http://localhost5APP_HOST=null6APP_PORT=82507APP_LOCALE=en8APP_KEY=9APP_TRANSPORT=null10HASH_FIELDS=password11 12MAX_BODY_SIZE=113MAX_UPLOAD_SIZE=5014TRUST_PROXY=false15 16SHIELD_ENABLED=false17SHIELD_DIFFICULTY=418SHIELD_THRESHOLD=7019 20MAX_COMPILED_CACHE_SIZE=50021MAX_TEMPLATE_SOURCE_CACHE_SIZE=50022 23STATIC_FILE_CACHE_MAX_FILES=10024STATIC_FILE_CACHE_MAX_SIZE=104857625STATIC_FILE_CACHE_MAX_TOTAL_BYTES=3355443226 27OPTIMIZE_CSS=true28 29TLS_CERT=null30TLS_KEY=null31TLS_CA=null32TLS_REDIRECT=true33 34QUEUE_MAX_WORKERS=435QUEUE_TIMEOUT=6000036QUEUE_SHUTDOWN_TIMEOUT=3000037 38DB_DRIVER=mysql39DB_HOST=localhost40DB_PORT=330641DB_USER=root42DB_PASS=43DB_NAME=dframework44DB_CONNECTION_LIMIT=1045DB_MAX_IDLE=546DB_IDLE_TIMEOUT=6000047DB_QUERY_CACHE_MAX_ENTRIES=20048DB_QUERY_CACHE_MAX_ROWS=100049 50SESSION_DRIVER=memory51SESSION_COOKIE=sid52SESSION_LIFETIME=12053SESSION_DOMAIN=null54SESSION_PATH=/55SESSION_SAME_SITE=Lax56SESSION_HTTP_ONLY=true57SESSION_SECURE=null58SESSION_MAX_SESSIONS=1000059 60STORAGE_ROOT=./storage61STORAGE_PUBLIC=./storage/publicフレームワークは起動時にこのファイルを解析します。引用符のない整数文字列(8250や-5など)は安全な整数にキャストされます。引用符のないtrue、false、nullの値は真偽値およびnullプリミティブにキャストされます。引用符で囲まれた値(単一引用符または二重引用符で囲まれた値)は厳密に文字列として保持され、数値のみのパスワード、ハッシュ、トークン、または先頭にゼロを含む文字列が型変換されるのを防ぎます。これらの値は設定ファイル全体でEnv.value()を介して即座に利用可能です。
`local`環境でアプリケーションの実行中に`.env`ファイルを変更した場合、フレームワークは新しい値を反映するためにサーバー全体を再起動します。
設定ファイル
configディレクトリ内の各ファイルはデフォルトのプレーンオブジェクトをエクスポートし、Env.value()を使用して環境変数から値を取得します。ファイル名はアプリケーション全体でドット記法ルックアップに使用される設定名前空間になります。
config/app.js
メインの設定ファイルであり、アプリケーションのコアランタイム動作を定義します。
1// config/app.js2import { Env } from 'dframework';3 4export default {5 name: Env.value('APP_NAME', 'dframework'),6 env: Env.value('APP_ENV', 'production'),7 debug: Env.value('APP_DEBUG', false),8 url: Env.value('APP_URL', 'http://localhost'),9 host: Env.value('APP_HOST', null),10 port: Env.value('APP_PORT', 8250),11 locale: Env.value('APP_LOCALE', 'en'),12 basePath: Env.value('APP_BASE_PATH', null),13 langPath: Env.value('APP_LANG_PATH', null),14 key: Env.value('APP_KEY'),15 hashFields: (Env.value('HASH_FIELDS') || 'password').split(',').map(s => s.trim()).filter(Boolean),16 17 maxBodySize: Env.value('MAX_BODY_SIZE', 1),18 maxUploadSize: Env.value('MAX_UPLOAD_SIZE', 50),19 trustProxy: Env.value('TRUST_PROXY', false),20 transport: Env.value('APP_TRANSPORT', null),21 22 shield: Env.value('SHIELD_ENABLED', false),23 shield_difficulty: Env.value('SHIELD_DIFFICULTY', 4),24 shield_threshold: Env.value('SHIELD_THRESHOLD', 70),25 26 maxCompiledCacheSize: Env.value('MAX_COMPILED_CACHE_SIZE', 500),27 maxTemplateSourceCacheSize: Env.value('MAX_TEMPLATE_SOURCE_CACHE_SIZE', 500),28 29 staticFileCache: {30 maxFiles: Env.value('STATIC_FILE_CACHE_MAX_FILES', 100),31 maxSize: Env.value('STATIC_FILE_CACHE_MAX_SIZE', 1024 * 1024),32 maxTotalBytes: Env.value('STATIC_FILE_CACHE_MAX_TOTAL_BYTES', 32 * 1024 * 1024),33 },34 35 css: {36 optimize: Env.value('OPTIMIZE_CSS', true),37 safelist: [],38 },39 40 tls: {41 cert: Env.value('TLS_CERT', null),42 key: Env.value('TLS_KEY', null),43 ca: Env.value('TLS_CA', null),44 redirect: Env.value('TLS_REDIRECT', true),45 },46 47 queue: {48 maxWorkers: Env.value('QUEUE_MAX_WORKERS', 4),49 timeout: Env.value('QUEUE_TIMEOUT', 60000),50 bootstrapTimeout: Env.value('QUEUE_BOOTSTRAP_TIMEOUT', 30000),51 shutdownTimeout: Env.value('QUEUE_SHUTDOWN_TIMEOUT', 30000),52 },53};
| キー | 環境変数 | 許容値 | デフォルト値 | 説明 |
|---|---|---|---|---|
name |
APP_NAME |
文字列 | 'dframework' |
バナーやログに表示されるアプリケーション名 |
env |
APP_ENV |
'production' | 'local' |
'production' |
ランタイム環境モード |
debug |
APP_DEBUG |
真偽値(true | false) |
false |
localモードで詳細なエラー診断トレースを有効化 |
url |
APP_URL |
文字列(有効なURL) | 'http://localhost' |
リンク、リダイレクト、CLIバナー用のベースURL |
host |
APP_HOST |
文字列 | null(例: '0.0.0.0'、'127.0.0.1'、null) |
HTTPサーバーがバインドするホストアドレス(nullは全インターフェースにバインド) |
port |
APP_PORT |
整数(1から65535) | 8250 |
HTTPサーバーのTCPポート番号 |
locale |
APP_LOCALE |
文字列(ISO言語コード 例: 'en'、'ja') |
'en' |
ビューローカライゼーションのデフォルト言語 |
basePath |
APP_BASE_PATH |
文字列(ディレクトリパス)| null | process.cwd() |
コントローラー、ジョブ、ミドルウェアのカスタムルートディレクトリ |
langPath |
APP_LANG_PATH |
文字列(ディレクトリパス)| null | null(ベースパス配下のlangを解決) |
ローカライゼーション辞書を含むカスタムディレクトリ |
key |
APP_KEY |
文字列(32文字以上) | なし(本番環境では必須) | セッション署名およびハッシュ化に使用されるアプリケーションシークレット |
hashFields |
HASH_FIELDS |
文字列配列(環境変数内ではカンマ区切り) | ['password'] |
データベース操作中に自動的にハッシュ化されるリクエストパラメータ |
maxBodySize |
MAX_BODY_SIZE |
整数(メガバイト) | 1 |
受信リクエストペイロードボディの最大サイズ(MB単位) |
maxUploadSize |
MAX_UPLOAD_SIZE |
整数(メガバイト) | 50 |
マルチパートファイルアップロードペイロードの最大サイズ(MB単位) |
trustProxy |
TRUST_PROXY |
真偽値(true | false) |
false |
x-forwarded-forおよびx-forwarded-protoプロキシヘッダーを信頼 |
transport |
APP_TRANSPORT |
null | 'http' |
null |
HTTPサーバートランスポートエンジン(nullはネイティブdfwsを自動検出しnode-httpへフォールバック) |
shield |
SHIELD_ENABLED |
真偽値(true | false) |
false |
対ボットProof of Workチャレンジ保護を有効化 |
shield_difficulty |
SHIELD_DIFFICULTY |
整数(正の整数) | 4 |
Proof of Workパズルの先頭16進ゼロ難易度 |
shield_threshold |
SHIELD_THRESHOLD |
整数(0から100) | 70 |
Proof of Work合格スコア |
maxCompiledCacheSize |
MAX_COMPILED_CACHE_SIZE |
整数(正の整数) | 500 |
メモリにキャッシュされるコンパイル済みビュー関数の最大数 |
maxTemplateSourceCacheSize |
MAX_TEMPLATE_SOURCE_CACHE_SIZE |
整数(正の整数) | 500 |
メモリにキャッシュされる生のテンプレートファイルの最大数 |
staticFileCache.maxFiles |
STATIC_FILE_CACHE_MAX_FILES |
整数(正の整数) | 100 |
メモリに保持される静的公開アセットの最大数 |
staticFileCache.maxSize |
STATIC_FILE_CACHE_MAX_SIZE |
整数(バイト) | 1048576(1 MB) |
静的キャッシュの対象となる個別の最大ファイルサイズ |
staticFileCache.maxTotalBytes |
STATIC_FILE_CACHE_MAX_TOTAL_BYTES |
整数(バイト) | 33554432(32 MB) |
静的ファイルメモリキャッシュの総割り当て上限 |
css.optimize |
OPTIMIZE_CSS |
真偽値(true | false) |
true |
本番ビルド時にCSSのパージと最小化を有効化 |
css.safelist |
なし | 文字列配列 | [] |
パージによる削除から保護されるCSSクラス名 |
tls.cert |
TLS_CERT |
文字列(ファイルパス)| null | null |
TLS SSL証明書ファイルへのパス |
tls.key |
TLS_KEY |
文字列(ファイルパス)| null | null |
TLS秘密鍵ファイルへのパス |
tls.ca |
TLS_CA |
文字列(ファイルパス)| null | null |
中間認証局バンドルファイルへのパス |
tls.redirect |
TLS_REDIRECT |
真偽値(true | false) |
true |
平文HTTPトラフィックをHTTPSへ自動リダイレクト |
queue.maxWorkers |
QUEUE_MAX_WORKERS |
整数(正の整数) | 4 |
バックグラウンドキューワーカープロセスの最大同時実行数 |
queue.timeout |
QUEUE_TIMEOUT |
整数(ミリ秒) | 60000 |
キューに入れられたジョブが強制終了されるまでの実行タイムアウト |
queue.bootstrapTimeout |
QUEUE_BOOTSTRAP_TIMEOUT |
整数(ミリ秒) | 30000 |
新規キューワーカーの起動完了までのタイムアウト(超過時は強制終了) |
queue.shutdownTimeout |
QUEUE_SHUTDOWN_TIMEOUT |
整数(ミリ秒) | 30000 |
キューワーカーのグレースフルシャットダウン待機タイムアウト |
config/auth.js
認証設定ではフレームワークが認証済みユーザーを解決するために使用するモデルとガードを登録します。
単一モデル認証
アプリケーション全体で単一のモデルが認証を処理する標準的な構成の場合:
1// config/auth.js2export default {3 model: 'User',4};マルチガード認証
アプリケーションで複数のユーザーエンティティ(一般ユーザーと管理者など)を使用する場合は明示的なガードを設定します:
1// config/auth.js2export default {3 default: 'web',4 guards: {5 web: {6 model: 'User',7 sessionKey: 'userId',8 },9 admin: {10 model: 'Admin',11 sessionKey: 'adminId',12 },13 },14};HTTP Basic認証
保護されたルートでBasic認証ヘッダーを有効にするには、basicキーの下に認証情報を定義します:
1// config/auth.js2export default {3 model: 'User',4 basic: {5 username: 'admin',6 password: 'password',7 realm: 'admin area',8 },9};| キー | 環境変数 | 許容値 | デフォルト値 | 説明 |
|---|---|---|---|---|
model |
なし | 文字列(models/配下のモデルクラス名) |
'User' |
単一ガード認証で使用されるプライマリモデルクラス |
default |
なし | 文字列(ガード名) | 'web' |
認証済みユーザーを解決する際に使用されるデフォルトガード |
guards |
なし | ガード定義オブジェクト | { web: { model: 'User', sessionKey: 'userId' } } |
ガード名とモデルおよびセッションキーのマッピング |
guards.<name>.model |
なし | 文字列(models/配下のモデルクラス名) |
'User' |
このガードで解決されるモデルクラス |
guards.<name>.sessionKey |
なし | 文字列(セッションキー名) | 'userId'(web/defaultの場合)または<name>Id |
認証済みユーザーIDを格納するセッションキー |
basic.username |
なし | 文字列 | なし | HTTP Basic認証に必要なユーザー名 |
basic.password |
なし | 文字列 | なし | HTTP Basic認証に必要なパスワード |
basic.realm |
なし | 文字列 | 'Restricted' |
401 www-authenticateヘッダーで返されるレルムプロンプト文字列 |
config/database.js
データベース設定では方言ドライバー、接続認証情報、プール制限、クエリキャッシュパラメータを定義します:
1// config/database.js2import { Env } from 'dframework';3 4export default {5 driver: Env.value('DB_DRIVER', 'mysql'),6 host: Env.value('DB_HOST', 'localhost'),7 port: Env.value('DB_PORT', 3306),8 user: Env.value('DB_USER', 'root'),9 pass: Env.value('DB_PASS', ''),10 name: Env.value('DB_NAME', 'dframework'),11 connectionLimit: Env.value('DB_CONNECTION_LIMIT', 10),12 maxIdle: Env.value('DB_MAX_IDLE', 5),13 idleTimeout: Env.value('DB_IDLE_TIMEOUT', 60000),14 queryCache: {15 maxEntries: Env.value('DB_QUERY_CACHE_MAX_ENTRIES', 200),16 maxRows: Env.value('DB_QUERY_CACHE_MAX_ROWS', 1000),17 },18};| キー | 環境変数 | 許容値 | デフォルト値 | 説明 |
|---|---|---|---|---|
driver |
DB_DRIVER |
'mysql' | 'pgsql' | 'sqlite' |
'mysql' |
データベースエンジンの方言ドライバー |
host |
DB_HOST |
文字列(ホスト名またはIP) | 'localhost' |
データベースサーバーホストアドレス(SQLiteでは未使用) |
port |
DB_PORT |
整数(1から65535) | 3306(mysql)または5432(pgsql) |
データベースサーバーポート番号 |
user |
DB_USER |
文字列 | 'root'(mysql)または'postgres'(pgsql) |
データベースユーザーアカウント |
pass |
DB_PASS |
文字列 | '' |
データベースユーザーパスワード |
name |
DB_NAME |
文字列 | アプリケーションデータベース名、またはSQLiteでは':memory:' |
データベース名またはSQLiteデータベースファイルパス |
connectionLimit |
DB_CONNECTION_LIMIT |
整数(正の整数) | 本番環境では20 / local環境では10 |
プール内の最大同時データベース接続数 |
maxIdle |
DB_MAX_IDLE |
整数(正の整数) | 5 |
プール内に保持される最大アイドル接続数 |
idleTimeout |
DB_IDLE_TIMEOUT |
整数(ミリ秒) | 60000 |
アイドル接続を切断するまでの時間 |
queryCache.maxEntries |
DB_QUERY_CACHE_MAX_ENTRIES |
整数(正の整数) | 200 |
LRUクエリキャッシュ内の最大キャッシュクエリプラン数 |
queryCache.maxRows |
DB_QUERY_CACHE_MAX_ROWS |
整数(正の整数) | 1000 |
LRUクエリキャッシュの対象となる結果あたりの最大行数 |
config/session.js
セッション設定ではユーザーセッションのドライバー、クッキー名、有効期間、クッキーパラメータを定義します:
1// config/session.js2import { Env } from 'dframework';3 4export default {5 driver: Env.value('SESSION_DRIVER', 'memory'),6 cookie: Env.value('SESSION_COOKIE', 'sid'),7 lifetime: Env.value('SESSION_LIFETIME', 120),8 domain: Env.value('SESSION_DOMAIN', null),9 path: Env.value('SESSION_PATH', '/'),10 same_site: Env.value('SESSION_SAME_SITE', 'Lax'),11 http_only: Env.value('SESSION_HTTP_ONLY', true),12 secure: Env.value('SESSION_SECURE', null),13 maxSessions: Env.value('SESSION_MAX_SESSIONS', 10000),14};| キー | 環境変数 | 許容値 | デフォルト値 | 説明 |
|---|---|---|---|---|
driver |
SESSION_DRIVER |
'memory' | 'database' | 'stealth' |
'memory' |
セッションストレージ機構のバックエンド |
cookie |
SESSION_COOKIE |
文字列(有効なクッキー名) | 'sid' |
クライアントに送信されるセッションIDクッキー名 |
lifetime |
SESSION_LIFETIME |
整数(分単位) | 120 |
有効期限までのセッション有効期間(分単位) |
domain |
SESSION_DOMAIN |
文字列 | null | null |
セッションクッキーのドメインスコープ |
path |
SESSION_PATH |
文字列 | '/' |
セッションクッキーのパススコープ |
same_site |
SESSION_SAME_SITE |
'Lax' | 'Strict' | 'None' |
'Lax' |
SameSiteクッキーポリシー |
http_only |
SESSION_HTTP_ONLY |
真偽値(true | false) |
true |
JavaScriptによるセッションクッキーへのアクセスを防止 |
secure |
SESSION_SECURE |
真偽値 | null(true | false | null) |
null |
セッションクッキーにHTTPSを要求(nullはリクエストから自動検出) |
maxSessions |
SESSION_MAX_SESSIONS |
整数(正の整数) | 10000 |
メモリドライバーによって保持される最大アクティブセッション数 |
config/storage.js
ストレージ設定ではStorageファサードを通じて利用可能なディスクを定義します:
1// config/storage.js2import { Env } from 'dframework';3 4export default {5 default: 'public',6 disks: {7 local: {8 root: Env.value('STORAGE_ROOT', './storage/local'),9 },10 public: {11 root: Env.value('STORAGE_PUBLIC', './storage/public'),12 },13 secure: {14 root: './storage/secure',15 encryptionKey: Env.value('APP_KEY'),16 },17 },18};| キー | 環境変数 | 許容値 | デフォルト値 | 説明 |
|---|---|---|---|---|
default |
なし | 文字列(ディスク名) | 'public' |
disk()で省略された場合に使用されるデフォルトストレージディスク名 |
disks |
なし | ディスク定義オブジェクト | { local, public, secure } |
ディスク名と設定オブジェクトのマッピング |
disks.<name>.root |
STORAGE_ROOT、STORAGE_PUBLICなど |
文字列(ディレクトリパス) | なし(各ディスクで必須) | ディスクルートのローカルファイルシステムディレクトリパス |
disks.<name>.encryptionKey |
APP_KEYまたはカスタムシークレット |
文字列(32文字以上)| null | null |
AES 256 GCM自動暗号化および復号化用のキー |
config/socket.js
ソケット設定ではリアルタイムWebSocketの動作と接続制限を制御します:
1// config/socket.js2import { Env } from 'dframework';3 4export default {5 maxPayload: Env.value('SOCKET_MAX_PAYLOAD', 1),6};| キー | 環境変数 | 許容値 | デフォルト値 | 説明 |
|---|---|---|---|---|
maxPayload |
SOCKET_MAX_PAYLOAD |
数値(メガバイト) | 1 |
WebSocketフレームの最大ペイロードサイズ(MB単位) |
config/native.js
ネイティブ設定ではアプリケーションをネイティブモバイルおよびデスクトップターゲット向けにビルドするためのすべての項目を定義します。このファイルはconfig/app.jsに加えてCLIカーネルによってロードされます。
1// config/native.js2export default {3 name: null,4 index: null,5 fallback: 'native/static/index.html',6 identifier: 'com.dframework.app',7 version: '1.0.0',8 build: 1,9 icon: { source: 'native/assets/icon.png', background: '#ffffff', padding: 0 },10 splash: { enabled: true, background: '#0a0a0a', icon: 'native/assets/icon.png', iconSize: 0.3, fadeOut: 300 },11 theme: { statusBar: 'dark', primary: '#d3ac5f', background: '#0a0a0a', navigationBar: '#0a0a0a', safeArea: true },12 ios: { orientation: 'all', statusBarHidden: false },13 android: { orientation: 'unspecified', minSdk: 24, targetSdk: 34, permissions: ['INTERNET'] },14 desktop: { width: 1280, height: 720, resizable: true, minWidth: 800, minHeight: 600, titleBarStyle: 'default' },15};| キー | 許容値 | デフォルト値 | 説明 |
|---|---|---|---|
name |
文字列 | null | null(app.nameへフォールバック) |
ホーム画面の表示名およびアプリケーションウィンドウタイトル |
index |
文字列(URLパス)| null | null |
ネイティブコンテナによって読み込まれる初期Webルート |
fallback |
文字列(ファイルパス) | 'native/static/index.html' |
リモートサーバーに接続できない場合のフォールバック静的HTMLファイル |
identifier |
文字列(逆ドメイン形式) | 'com.dframework.app' |
AppleおよびAndroidパッケージ用の一意なバンドル識別子 |
version |
文字列(セマンティックバージョン) | '1.0.0' |
ユーザー向けアプリケーションバージョン文字列 |
build |
整数(正の整数) | 1 |
インクリメンタルビルド番号(Androidバージョンコード) |
icon.source |
文字列(ファイルパス) | 'native/assets/icon.png' |
ソースアイコン画像パス(1024x1024 PNG) |
icon.background |
文字列(16進カラーコード) | '#ffffff' |
Android向けアダプティブアイコンの背景色 |
icon.padding |
数値(0から1の小数) | 0 |
アイコンのインセットパディング比率 |
splash.enabled |
真偽値(true | false) |
true |
ネイティブ起動スプラッシュ画面を有効化 |
splash.background |
文字列(16進カラーコード) | '#0a0a0a' |
スプラッシュ画面の背景色 |
splash.icon |
文字列(ファイルパス) | 'native/assets/icon.png' |
スプラッシュ画面の中央アイコン画像パス |
splash.iconSize |
数値(0から1の小数) | 0.3 |
画面領域に対するスプラッシュアイコンの縮尺比 |
splash.fadeOut |
整数(ミリ秒) | 300 |
スプラッシュ画面消去時のトランジション時間(ミリ秒) |
theme.statusBar |
'light' | 'dark' |
'dark' |
ネイティブステータスバーアイコンの外観 |
theme.primary |
文字列(16進カラーコード) | '#d3ac5f' |
プライマリブランドアクセントカラー |
theme.background |
文字列(16進カラーコード) | '#0a0a0a' |
WebViewおよびウィンドウコンテナの背景色 |
theme.navigationBar |
文字列(16進カラーコード) | '#0a0a0a' |
Android下部システムナビゲーションバーの色 |
theme.safeArea |
真偽値(true | false) |
true |
WebViewコンテンツがデバイスのセーフエリアインセットを尊重 |
ios.orientation |
'all' | 'portrait' | 'landscape' |
'all' |
iOSで許可されるデバイス画面の向き |
ios.statusBarHidden |
真偽値(true | false) |
false |
iOSステータスバーを非表示にする |
android.orientation |
'unspecified' | 'portrait' | 'landscape' |
'unspecified' |
Androidで許可される画面の向き |
android.minSdk |
整数(SDK APIレベル) | 24 |
サポートされる最小Android SDKバージョン |
android.targetSdk |
整数(SDK APIレベル) | 34 |
ターゲットAndroid SDKバージョン |
android.permissions |
文字列配列 | ['INTERNET'] |
Androidマニフェストで宣言されるパーミッション |
desktop.width |
整数(ピクセル) | 1280 |
デスクトップアプリケーションのデフォルトウィンドウ幅 |
desktop.height |
整数(ピクセル) | 720 |
デスクトップアプリケーションのデフォルトウィンドウ高さ |
desktop.minWidth |
整数(ピクセル)| undefined | 800 |
許可される最小デスクトップウィンドウ幅 |
desktop.minHeight |
整数(ピクセル)| undefined | 600 |
許可される最小デスクトップウィンドウ高さ |
desktop.resizable |
真偽値(true | false) |
true |
ユーザーによるデスクトップウィンドウのリサイズを許可 |
desktop.titleBarStyle |
'default' | 'hidden' |
'default' |
デスクトップウィンドウのタイトルバー外観 |
config/view.js
dframeworkはビューエンジンの設定用として任意のconfig/view.js設定ファイルをサポートしています。
1// config/view.js2import { Env } from 'dframework';3 4export default {5 maxYieldDepth: Env.value('VIEW_MAX_YIELD_DEPTH', 30),6};| キー | 環境変数 | 許容値 | デフォルト値 | 説明 |
|---|---|---|---|---|
maxYieldDepth |
VIEW_MAX_YIELD_DEPTH |
整数(正の整数) | 30 |
ネストされた@yieldセクション解決の最大再帰深度 |
設定値へのアクセス
dframeworkはあらゆるコンテキストで利用可能なグローバルなConfigファサードを提供します。最初のセグメントが設定ファイル名、残りがそのファイル内のキーパスとなるドット記法を使用して値を取得します。
1const env = Config.get('app.env');2const dbName = Config.get('database.name');3const authModel = Config.get('auth.model', 'User');4 5if (Config.has('database.host')) {6 // configuration key is defined7}Config.getの第2引数はキーが存在しない場合に返される任意のフォールバック値です。フォールバックが指定されておらずキーが見つからない場合、メソッドはnullを返します。設定キーが定義されているかどうかを確認するにはConfig.hasを使用します。
環境変数へのアクセス
設定ファイル内ではEnv.value()を使用して解析された.envファイルから値を読み取ります。設定システムを経由せずに生の環境変数の値が必要な場所であればどこでも使用できます。
1import { Env } from 'dframework';2 3const port = Env.value('APP_PORT', 8250);4const dbHost = Env.value('DB_HOST', 'localhost');
設定のホットリロード
local環境ではフレームワークはファイル変更を検知するためにconfigディレクトリ全体を監視します。設定ファイルまたは.envを保存すると、ウォッチャーが変更を検知してサーバープロセスを再起動するため更新された設定値が即座に反映されます。

