初回作成時のサンプルのカウントアッププログラムを読み解く

こんにちはnasustです。 Flutterのプロジェクト作成時のカウントアップするサンプルプログラムを読み解きます。

class MyApp extends StatelessWidget

void main() => runApp(MyApp());

class MyApp extends StatelessWidget {
  // This widget is the root of your application.
  
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        // This is the theme of your application.
        //
        // Try running your application with "flutter run". You'll see the
        // application has a blue toolbar. Then, without quitting the app, try
        // changing the primarySwatch below to Colors.green and then invoke
        // "hot reload" (press "r" in the console where you ran "flutter run",
        // or simply save your changes to "hot reload" in a Flutter IDE).
        // Notice that the counter didn't reset back to zero; the application
        // is not restarted.
        primarySwatch: Colors.blue,
      ),
      home: MyHomePage(title: 'Flutter Demo Home Page'),
    );
  }
}
dart

void main() => runApp(MyApp());

void main()は調べる事もなくエントリーポイントですね。runApp()は引数で指定したWidgetを画面全体に調節して表示する関数です。

runApp function - widgets library - Dart API

StatelessWidget

このStatelessWidgetクラスは状態を持たないWidgetです。 状態というのは変数と画面状態の紐づけの事です。 変数が変化すれば画面が再描画されて変数の内容が反映される様な事です。

StatelessWidgetクラスの対となるのはStatefulWidgetクラスです。 この様に分けているのはパフォーマンスを考慮しているからと思われます。 クラスで明示的に状態変化で描画を更新する必要ないと示しています。

StatelessWidget class - widgets library - Dart API

Widget build(BuildContext context)

Widget buildは、Widgetを作成するメソッドです。UIの子孫関係のツリーに挿入されたタイミングなどで呼ばれます。StatelessWidgetなWidgetを返す実装を求められています。

APIのドキュメントで、タイミングとパフォーマンスについて説明されています。

build method - StatelessWidget class - widgets library - Dart API

BuildContextは、現在のUIのツリーに関するプロパティやメソッド持ったクラスです。 先祖や子孫のWidgetを探したりするメソッドがあります。

return MaterialApp

マテリアルデザインのアプリの一般的に必要な機能を提供するウィジェットです。 ナビゲーションやデザインに関するプロパティがあります。

MaterialApp class - material library - Dart API

home: MyHomePage(title: ‘Flutter Demo Home Page’),

MaterialAppで最初に表示するWidgetを指定します。

class MyHomePage extends StatefulWidget

class MyHomePage extends StatefulWidget {
  MyHomePage({Key key, this.title}) : super(key: key);

  // This widget is the home page of your application. It is stateful, meaning
  // that it has a State object (defined below) that contains fields that affect
  // how it looks.

  // This class is the configuration for the state. It holds the values (in this
  // case the title) provided by the parent (in this case the App widget) and
  // used by the build method of the State. Fields in a Widget subclass are
  // always marked "final".

  final String title;

  
  _MyHomePageState createState() => _MyHomePageState();
}
dart

StatefulWidget

状態変化で画面を再描画するWidgetです。 StatelessWidgetと違い、状態を表す変数が変化すると適切なタイミングで再描画します。

StatefulWidgetを継承したクラスはcreateStateでStateを返す実装をする必要があります。

StatefulWidgetは状態変化を前提としたクラスです。このWidgetが状態変化すると子供のWidget全体が再ビルドされます。この再ビルドとパフォーマンスについて考慮する必要があります。公式ドキュメントには、その注意点が解説されています。

StatefulWidget class - widgets library - Dart API

class _MyHomePageState extends State

class _MyHomePageState extends State<MyHomePage> {
  int _counter = 0;

  void _incrementCounter() {
    setState(() {
      // This call to setState tells the Flutter framework that something has
      // changed in this State, which causes it to rerun the build method below
      // so that the display can reflect the updated values. If we changed
      // _counter without calling setState(), then the build method would not be
      // called again, and so nothing would appear to happen.
      _counter++;
    });
  }

  
  Widget build(BuildContext context) {
    // This method is rerun every time setState is called, for instance as done
    // by the _incrementCounter method above.
    //
    // The Flutter framework has been optimized to make rerunning build methods
    // fast, so that you can just rebuild anything that needs updating rather
    // than having to individually change instances of widgets.
    return Scaffold(
      appBar: AppBar(
        // Here we take the value from the MyHomePage object that was created by
        // the App.build method, and use it to set our appbar title.
        title: Text(widget.title),
      ),
      body: Center(
        // Center is a layout widget. It takes a single child and positions it
        // in the middle of the parent.
        child: Column(
          // Column is also layout widget. It takes a list of children and
          // arranges them vertically. By default, it sizes itself to fit its
          // children horizontally, and tries to be as tall as its parent.
          //
          // Invoke "debug painting" (press "p" in the console, choose the
          // "Toggle Debug Paint" action from the Flutter Inspector in Android
          // Studio, or the "Toggle Debug Paint" command in Visual Studio Code)
          // to see the wireframe for each widget.
          //
          // Column has various properties to control how it sizes itself and
          // how it positions its children. Here we use mainAxisAlignment to
          // center the children vertically; the main axis here is the vertical
          // axis because Columns are vertical (the cross axis would be
          // horizontal).
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            Text(
              'You have pushed the button this many times:',
            ),
            Text(
              '$_counter',
              style: Theme.of(context).textTheme.display1,
            ),
          ],
        ),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: _incrementCounter,
        tooltip: 'Increment',
        child: Icon(Icons.add),
      ), // This trailing comma makes auto-formatting nicer for build methods.
    );
  }
}
dart

State

状態と状態変化して再ビルドしたWidgetを返すクラスです。

State class - widgets library - Dart API

setState()

setStateは状態が変化した事をFlutterのフレームワークに通知します。通知を受け取ったフレームワークはWidgetの再ビルドをします。

再ビルドのコストのついて以下のページで解説されています。

Performance best practices - Flutter

Widget build(BuildContext context)

Widgetの作成するメソッドです。Stateクラスにbuildメソッドがあるのは、状態変化とbuildが暗黙的に、密接に関係があると示す為です。

Scaffold

マテリアルデザインのレイアウトの構造を提供するWidgetです。 サンプルのプログラムのコンストラクターでレイアウトの構造を渡しています。

コンストラクターのパラメーターは以下のページで解説されています。

Scaffold class - material library - Dart API

Scaffold constructor - Scaffold class - material library - Dart API

{}で囲っている引数は、optional parametersという機能です。JSONっぽい感じですね。

Language tour | Dart

このパラメーターでレイアウトの構造を指定しています。

$_counter

$ + 変数名で文字列内に変数を埋め込む事が出来ます。

Language tour | Dart

FloatingActionButton

マテリアルデザインで円形の1番目立つ浮かんでいるボタンです。 onPressedで、状態変化する_incrementCounterメソッドを呼ぶ様にしています。

まとめ

サンプルプログラムを読み解くと既存のGUIプログラミングより分かりやすい印象です。 stateが無いGUIプログラミングですとUIの状態変化を手動でやるので冗長になりがちですが、Flutterはスマートですね。

FlutterのAPIドキュメントは読みやすいです。パフォーマンスについて解説してあったりと開発のヒントも示してくれます。

次回からは実際にアプリを開発して、その解説の連載になります。

prevnext