v0.21

プロジェクト構造

はじめに

dframeworkは決定論的なアプリケーション構造を強制します。デフォルトのディレクトリ構造を設定や変更することはできません。この厳格さによりフレームワークで構築されたすべてのアプリケーションがどの開発者にとっても即座に馴染み深いものとなり、内部エンジンがロードパスやコンパイルパスを積極的に最適化できるようになります。

NOTE

このディレクトリ構造から逸脱しようとすると、ブートシーケンスまたはビューコンパイルフェーズでフレームワークエンジンが失敗します。

ルートディレクトリ

configディレクトリ

configディレクトリにはすべての設定ファイルが保持されます。各ファイルはファイル名の名前空間にマッピングされたデフォルトオブジェクトをエクスポートします。

1// config/app.js
2import { 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 port: Env.value('APP_PORT', 8250),
10 locale: Env.value('APP_LOCALE', 'en'),
11 key: Env.value('APP_KEY'),
12 hashFields: (Env.value('HASH_FIELDS') || 'password').split(',').map(s => s.trim()).filter(Boolean),
13
14 maxBodySize: Env.value('MAX_BODY_SIZE', 1),
15 maxUploadSize: Env.value('MAX_UPLOAD_SIZE', 50),
16
17 shield: Env.value('SHIELD_ENABLED', false),
18
19 // tls: {
20 // cert: Env.value('TLS_CERT'),
21 // key: Env.value('TLS_KEY'),
22 // ca: Env.value('TLS_CA'),
23 // redirect: Env.value('TLS_REDIRECT', true),
24 // },
25
26 queue: {
27 maxWorkers: Env.value('QUEUE_MAX_WORKERS', 4),
28 },
29};
1// config/auth.js
2export default {
3 model: 'User',
4
5 // default: 'web',
6 // guards: {
7 // web: {
8 // model: 'User',
9 // sessionKey: 'userId'
10 // },
11 // admin: {
12 // model: 'Admin',
13 // sessionKey: 'adminId'
14 // }
15 // }
16};
1// config/database.js
2import { 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};
1// config/session.js
2import { 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};
1// config/storage.js
2import { Env } from 'dframework';
3
4export default {
5 disks: {
6 local: {
7 root: Env.value('STORAGE_ROOT', './storage/local'),
8 },
9 public: {
10 root: Env.value('STORAGE_PUBLIC', './storage/public'),
11 },
12 secure: {
13 root: './storage/secure',
14 encryptionKey: Env.value('APP_KEY'),
15 },
16 },
17};
1// config/native.js
2export 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};

consoleディレクトリ

バックグラウンドタスクとスケジューリング定義はconsoleディレクトリに配置されます。フレームワークは定期実行ジョブやバックグラウンドワーカーを設定するために、このディレクトリにあるスケジュール定義ファイルを特定して参照します。カスタムコマンドもここで登録されます。

1// console/Schedule.js
2export default function (scheduler) {
3 scheduler.command('CleanupExpiredSessions').daily();
4}

controllersディレクトリ

controllersディレクトリには受信リクエストロジックを処理するクラスが含まれます。コントローラーはルーターによって自動的に呼び出されるシンプルな非同期メソッドへと振る舞いをまとめます。継承すべきベースコントローラークラスは存在しません。ロジックで必要としない場合、リクエストやレスポンスオブジェクトなどの引数は完全に任意です。

1// controllers/IndexController.js
2export default class IndexController {
3 async index() {
4 return render('index');
5 }
6}

databaseディレクトリ

databaseディレクトリにはマイグレーションやシーダーを含むすべてのデータベース関連ファイルが保持されます。フレームワークはスキーマ構築コマンドを実行する際にこのディレクトリを利用し、環境間でのデータベースの変更追跡を可能にします。

1// database/migrations/2026_01_01_000000_create_users_table.js
2export async function up() {
3 await Schema.create('users', table => {
4 table.increments();
5 table.string('email').unique();
6 table.string('password');
7 table.timestamps();
8 });
9}
10
11export async function down() {
12 await Schema.dropIfExists('users');
13}
1// database/seeders/DatabaseSeeder.js
2export async function run() {
3 await table('users').insert({
4 email: 'admin@example.com',
5 password: 'password'
6 });
7}

jobsディレクトリ

jobsディレクトリにはワーカースレッドによって非同期に実行されるバックグラウンドジョブクラスが配置されます。すべてのジョブクラスはhandle(payload)メソッドを持つデフォルトクラスをエクスポートし、アプリケーション全体でJob.dispatch()を介してディスパッチされます。

1// jobs/SendWelcomeEmailJob.js
2export default class SendWelcomeEmailJob {
3 async handle(payload) {
4 const user = await User.find(payload.userId);
5 await Mailer.send(user.email, 'welcome', { name: user.name });
6 }
7}

langディレクトリ

ローカライゼーション文字列と翻訳辞書はlangディレクトリに保存されます。これらは通常ロケール固有のフォルダ内にJSONファイルとして配置されます。フレームワークはこれらのファイルを自動的にロードし、アプリケーションおよびビューテンプレート全体で多言語サポートを提供します。

1// lang/en/common.json
2{
3 "welcome": "welcome to dframework",
4 "login": "log in to your account"
5}

middlewaresディレクトリ

middlewaresディレクトリにはアプリケーションに入るHTTPリクエストをフィルタリングおよび検査するクラスが含まれます。コントローラーに到達する前に認証、レートリミット、リクエスト操作を強制するカスタムロジックをここで定義します。

1// middlewares/EnsureAuth.js
2export default class EnsureAuth {
3 handle(req, next) {
4 if (!Auth.check()) return abort(401);
5 return next(req);
6 }
7}

modelsディレクトリ

Active Recordエンティティはmodelsディレクトリに配置されます。フレームワークは認証フローや暗黙的なルートモデルバインディングなどでモデルを動的に解決する際にこの正確な場所に依存します。モデルはデータベーススキーマ抽象化の唯一の信頼できる情報源を表します。

1// models/User.js
2export default class User extends Model {
3 // model definition
4}

nativeディレクトリ

nativeディレクトリにはWebアプリケーションをネイティブモバイルおよびデスクトップ環境に統合するために特異的に必要なコードが含まれます。フレームワークはこのディレクトリを利用してネイティブコンパイルとアセット注入を処理し、WebViewとネイティブデバイス機能を橋渡しします。

publicディレクトリ

静的アセットや一般公開ファイルはpublicディレクトリに配置されます。内部Webサーバーはローカル開発中にこれらのファイルを直接提供できます。本番環境ではこのディレクトリがWebサーバー構成のドキュメントルートとして機能します。

routesディレクトリ

routesディレクトリはすべての受信リクエストのエントリポイントです。フレームワークはこのフォルダ内にあるすべてのルーティング定義を自動的に読み込んで登録します。ここでWebエンドポイントとアプリケーションロジックのマッピングを定義します。フレームワークが起動プロセス中に自動検出を処理するため、これらのファイルを他の場所で手動インポートする必要はありません。

1// routes/web.js
2Route.get('/', 'HomeController@index');

storageディレクトリ

storageディレクトリはアプリケーションによって生成されたファイル用に予約されています。これにはキャッシュされたビュー、一時的なホットリロードデータ、ユーザーがアップロードしたコンテンツが含まれます。フレームワークはこのディレクトリの内部構造を自動的に管理し、公開アクセス可能なアップロードファイル用のシンボリックリンクを維持します。

viewsディレクトリ

viewsディレクトリにはすべてのフロントエンドテンプレートが含まれます。内部ビューコンパイラは本番ビルドパイプライン中にこれらのテンプレートを静的に解析して最適化します。コンパイルエンジンはこのパスを明示的なターゲットとしているため、テンプレートをこのディレクトリの外に配置することはできません。

1@extends('layouts.app')
2
3@section('content')
4 <div>welcome to dframework</div>
5@endsection