How to force a Flutter application restart (in production mode)?

Question

In production mode, is there a way to force a full restart of the application (I am not talking about a hot reload at development time!).

Practical use cases:

• At initialization process the application detects that there is no network connection. The lack of network connectivity might have prevented a correct start up (e.g. loading of external resource such as JSON files...).

• During the initial handshaking, new versions of some important resources need to be downloaded (kind of update).

In both use cases, I would like the application to proceed with a full restart, rather than having to build a complex logic at the ApplicationState level.

Answer 1

You could wrap your whole app into a statefulwidget. And when you want to restart you app, rebuild that statefulwidget with a child that possess a different Key.

This would make you loose the whole state of your app.

import 'package:flutter/material.dart';

void main() {
  runApp(
    RestartWidget(
      child: MaterialApp(),
    ),
  );
}

class RestartWidget extends StatefulWidget {
  RestartWidget({this.child});

  final Widget child;

  static void restartApp(BuildContext context) {
    context.findAncestorStateOfType<_RestartWidgetState>().restartApp();
  }

  @override
  _RestartWidgetState createState() => _RestartWidgetState();
}

class _RestartWidgetState extends State<RestartWidget> {
  Key key = UniqueKey();

  void restartApp() {
    setState(() {
      key = UniqueKey();
    });
  }

  @override
  Widget build(BuildContext context) {
    return KeyedSubtree(
      key: key,
      child: widget.child,
    );
  }
}

In this example you can reset your app from everywhere using RestartWidget.restartApp(context).

Answer 2

The flutter_phoenix package is based on Rémi Rousselet's answer, making it even simpler.

void main() {
  runApp(
    Phoenix(
      child: App(),
    ),
  );
}

Then when you need to restart the app, just call:

Phoenix.rebirth(context);

Answer 3

I developed the restart_app plugin, with +200 likes in pub.dev, to restart the whole app with native APIs.

---

Update May 25, 2023:

The package now supports all Android, iOS and Web platforms.

Answer 4

I just want to add Regarding I have Tried @Remi answer which works great on most of the cases to restart the app. The only problem with the answer is that some things if you are doing Navigation route extensively you probably go to a state which It gives you an error like, The method 'restartApp' was called on null. To resolve this error you have to know the Context and use Navigator.of(context).pop(); multiples times back. For me, the solution is that just go to the initial route. It will inject all the states from a new. Where you want to restart just add this Line.

 Navigator.pushNamedAndRemoveUntil(context,'/',(_) => false);

If you want to only restart a specific widget then the Remi solution is awesome. Thanks for the solution Remi though. It help me understand states in flutter.

Answer 5

You can also use the runApp(new MyWidget) function to do something similar

This is what this function does:

Inflate the given widget and attach it to the screen.

The widget is given constraints during layout that force it to fill the entire screen. If you wish to align your widget to one side of the screen (e.g., the top), consider using the Align widget. If you wish to center your widget, you can also use the Center widget

Calling runApp again will detach the previous root widget from the screen and attach the given widget in its place. The new widget tree is compared against the previous widget tree and any differences are applied to the underlying render tree, similar to what happens when a StatefulWidget rebuilds after calling State.setState.

https://docs.flutter.io/flutter/widgets/runApp.html

Answer 6

So simple package: flutter_restart

dependencies:
flutter_restart: ^0.0.3

to use:

void _restartApp() async {
  FlutterRestart.restartApp();
}

Answer 7

I have found Hossein's restart_app package also pretty useful for native restarts (not only on Flutter level).

To everyone having the MissingPluginException error, just reinstall the app again on the device, means that hot reload won't work. The app has native methods which need to compiled in the Android/iOS App.

Answer 8

Thecnically this is not a restart but it will work for most of the scenarios:

// Remove any route in the stack
Navigator.of(context).popUntil((route) => false);

// Add the first route. Note MyApp() would be your first widget to the app.
Navigator.push(
  context,
  CupertinoPageRoute(builder: (context) => const MyApp()),
);

Answer 9

I wanted to restart my app after logout. so I used https://pub.dev/packages/flutter_phoenix (flutter phoenix). It worked for me.

1. Install flutter_phoenix by running this command on your terminal inside your flutter app directory. $ flutter pub add flutter_phoenix
2. Import it inside your "main.dart".
3. Wrap your root widget inside Phoenix.

     runApp(
    Phoenix(
      child: MyApp()
  ));

4. Now you can call this wherever you want to restart your app :- Phoenix.rebirth(context)

Note: flutter_phoenix does not restart the app on OS level, it only restarts the app on app level.

Answer 10

Follow the steps-

1. Go to your terminal and type in the following:

flutter pub add flutter_restart

This will update some dependencies in pubspec.yaml file.

2. Import the following package in whichever file you want to implement the restart code-

import 'package:flutter_restart/flutter_restart.dart';

3. Create a void function

void _restartApp() async {
  await FlutterRestart.restartApp();
}

4. Write this wherever you want to start the app-

_restartApp();

Answer 11

I tried the above suggested methods and none of them worked and i was using getx. so i ended up modified the accepted answer with a delay as a workaround and it works now.

   class RestartAppWidget extends StatefulWidget {
  RestartAppWidget({this.child});

  final Widget child;

  static void restartApp(BuildContext context) {
    context.findAncestorStateOfType<_RestartAppWidgetState>().restartApp();
  }

  @override
  _RestartAppWidgetState createState() => _RestartAppWidgetState();
}

class _RestartAppWidgetState extends State<RestartAppWidget> {
  bool restarting = false;

  void restartApp() async {
    restarting = true;   // restart variable is set to true
    setState(() {});
    Future.delayed(Duration(milliseconds: 300)).then((value) {
      setState(() {
        restarting = false; //restart variable is set to false
      });
    });
    // setState(() {
    //   key = UniqueKey();
    // });
  }

  @override
  Widget build(BuildContext context) {
    if (restarting) {
      return SizedBox();   //an empty Sizedbox is displayed for 300 milliseconds you can add a loader if you want
    }
    return SizedBox(
      child: widget.child,
    );
  }
}`

wrap the root widget with RestartAppWidget

  runApp(RestartAppWidget(
      child: MyApp(),
    ))

you can use this code to restart the app at flutter level

RestartAppWidget.restartApp(Get.context);