v0.21

ネイティブアプリケーション

はじめに

dframeworkを使用するとWebアプリケーションをios、android、desktopプラットフォーム向けのネイティブアプリとしてパッケージ化できます。ネイティブレイヤーは軽量なwebviewラッパーでありアプリケーションロジックを完全にWebベースに保ちながらjavascriptブリッジを通じてデバイスapiへのアクセスを提供します。

個別のコードベースや複雑なビルド設定を必要とするハイブリッドフレームワークとは異なりdframeworkは単一の信頼できる情報源を維持します。ルート、コントローラー、モデル、ビューはWeb環境とネイティブ環境でまったく同じように動作します。

サポート対象プラットフォーム

フレームワークは3つのプラットフォーム向けにネイティブランタイムを提供します:

各ランタイムには自動ネットワーク適応、javascriptポリフィル、統一されたブリッジapiが含まれています。カスタムネイティブプラグインが必要な場合を除きアプリケーションにプラットフォーム固有のコードは必要ありません。

設定

基本セットアップ

ネイティブ設定はプロジェクトルートのconfig/native.jsに配置されます。フレームワークは設定を適切なデフォルト値とマージします。

1export default {
2 name: 'myapp',
3 identifier: 'com.example.myapp',
4 version: '1.0.0',
5 build: 1,
6};

nameフィールドを省略した場合フレームワークはフォールバックとしてConfig('app.name')を使用します。

アプリケーション識別子

IMPORTANT

`config/native.js`の`identifier`はリバースドメイン表記(例: `com.example.myapp`)に従う必要があります。この値は配信後に新しいアプリ掲載情報を公開することなく変更することはできません。

1export default {
2 identifier: 'com.example.myapp',
3 version: '2.1.0',
4 build: 42,
5};

version文字列はユーザー向けです。build番号はリリースごとにインクリメントする必要がありアプリストアでバージョンを区別するために使用されます。

url設定

デフォルトではネイティブアプリはConfig('app.url')とConfig('app.port')からコンテンツをロードします。indexフィールドを設定することでこの動作をオーバーライドできます。

1export default {
2 index: 'https://myapp.com',
3};

indexがnullの場合フレームワークはプライマリアプリケーション設定からurlを構築します。これによりapi urlを変更すると手動で同期することなくネイティブビルドが自動的に更新されます。

シミュレーション中フレームワークは環境変数を介して開発サーバーのurlを注入するため本番設定に関係なくlocalhostに対してテストできます。

静的フォールバック

リモートurlにアクセスできない場合のフォールバックとして静的htmlサイトをネイティブアプリケーション内にバンドルできます。これによりオフライン機能を有効にしたりリトライロジックを備えたエラーページを提供したりできます。

1export default {
2 index: 'https://api.myapp.com',
3 fallback: 'native/static/index.html',
4};

静的サイトはバンドルされたdframework cssおよびjavascriptランタイムに完全にアクセスできます。静的ファイルはnative/static/ディレクトリに配置してください。フレームワークはビルド中にこのディレクトリをネイティブバンドルにコピーします。

最小限のフォールバックページではリロードボタン付きのネットワークエラーを表示できます:

1<!DOCTYPE html>
2<html>
3<head>
4 <meta charset="utf-8">
5 <meta name="viewport" content="width=device-width, initial-scale=1">
6 <link rel="stylesheet" href="/css/dstrn.css">
7 <title>offline</title>
8</head>
9<body class="bg-container flex-center" style="height: 100vh;">
10 <div class="flex-column g-2 text-center p-2">
11 <h1>no connection</h1>
12 <p class="text-content-secondary">
13 please check your internet connection and try again
14 </p>
15 <button onclick="location.reload()">retry</button>
16 </div>
17 <script src="/js/dstrn.js"></script>
18</body>
19</html>

ネイティブランタイムはプライマリurlが失敗したときに自動的にフォールバックのロードを試みます。またindexをnullに設定し完全な静的実装を提供することで完全なオフラインアプリケーションを構築することもできます。

開発ワークフロー

シミュレーション

開発中にネイティブ環境でアプリケーションをテストするにはsimulateコマンドを使用します。サーバーがまだ実行されていない場合フレームワークは自動的にサーバーを起動します。

1dstrn simulate --ios
2dstrn simulate --android
3dstrn simulate --desktop

シミュレーターはローカル開発サーバーに接続します。ブラウザと同様にリフレッシュ後にアプリケーションコードの変更が即座に反映されます。

rキーを押してネイティブアプリをリフレッシュします。qキーを押して終了します。

ビルド

buildコマンドは配信用の本番バイナリをコンパイルします。ビルドはプラットフォームごとに整理されnative/builds/に出力されます。

1dstrn build --ios
2dstrn build --android
3dstrn build --desktop

本番ビルドでは設定されたindex urlが使用されます。明示的な値を設定していない場合フレームワークはconfig/app.jsの本番apiエンドポイントを使用します。

ビルドにはプラットフォーム固有のツールチェーンが必要です。環境セットアップの手順についてはビルドと配信のドキュメントを参照してください。

プロジェクト構成

ネイティブアセットと設定はプロジェクトルートのnativeディレクトリに配置されます:

1native/
2├── assets/
3│ └── icon.png # application icon
4├── static/ # optional static fallback site
5│ ├── index.html
6│ ├── css/
7│ └── js/
8└── builds/ # compiled binaries (gitignored)
9 ├── ios/
10 ├── android/
11 └── desktop/

フレームワークはコンパイル中にbuildsディレクトリを生成します。バージョン管理からは除外してください。

icon.pngファイルは1024x1024ピクセル以上である必要があります。フレームワークはビルドプロセス中に各プラットフォームに必要なすべてのサイズと形式を自動的に生成します。