Flutter web: navegando por URLs com rotas nomeadas
Rotas nomeadas podem ser usadas para navegar entre páginas dentro de um app Flutter mobile, mas também funcionam para URLs em apps Flutter web.
👉 Atualização: o novo sistema de Navegação e Roteamento do Flutter já está disponível, e é a forma preferida de lidar com URLs no Flutter.
Named routes podem ser usadas para navegar entre páginas dentro de um app Flutter mobile, mas também funcionam para URLs em apps Flutter web. Este artigo explica como adicionar named routes ao seu app e como personalizá-las para ter correspondência de padrões dentro das rotas.
Definindo named routes
Named routes podem ser adicionadas à sua aplicação definindo-as dentro da classe MaterialApp. A propriedade MaterialApp.routes contém um mapa que lista cada named route e o widget de exibição associado a ela. A propriedade MaterialApp.initialRoute determina qual rota é exibida quando o app inicia. Por isso, a initialRoute precisa ser definida dentro da propriedade routes. Por exemplo:
MaterialApp(
initialRoute: '/',
routes: {
'/': (context) => HomePage(),
'/overview': (context) => OverviewPage(),
},
);
Uma boa prática para manter o código organizado é colocar as named routes em variáveis estáticas, por exemplo, nos próprios widgets:
class OverviewPage extends StatelessWidget {
static const String route = '/overview';
}
Em seguida, refatore MaterialApp.routes com as named routes agora definidas como variáveis estáticas:
MaterialApp(
initialRoute: HomePage.route,
routes: {
HomePage.route: (context) => HomePage(),
OverviewPage.route: (context) => OverviewPage(),
},
);
Navegando entre páginas
Para navegar de uma página para outra, basta empilhar a named route no navigator:
RaisedButton(
onPressed: () {
Navigator.of(context).pushNamed(OverviewPage.route);
},
)
Veja um exemplo interativo completo disso no DartPad. Se você compilar e
executar o aplicativo você mesmo para a web, também pode simplesmente digitar
/#/overview dentro do navegador. Isso empilha a rota chamada overview no
Navigator e leva você ao widget OverviewPage, como você pode ver no GIF a seguir:
Lógica de roteamento para URLs dinâmicas
Você pode precisar lidar com cenários mais complexos do que os abordados aqui, como ter correspondência de padrões dentro das rotas para permitir URLs dinâmicas. Para estender este exemplo, suponha que você tenha muitos artigos diferentes na página de visão geral. Para cada artigo, você quer poder navegar diretamente por meio de URLs:
/#/article/a-very-interesting-article
/#/article/newsworthy-news
Definir named routes para todos os artigos dentro do MaterialApp não escala bem. Para casos dinâmicos como esse, é preciso fazer algo mais personalizado. No momento em que este texto foi escrito, o canal stable do Flutter estava na v1.12, e não existe uma
forma simples de fazer isso, embora haja planos para adicionar suporte a roteamento mais avançado com o
novo Navigator.
Por enquanto, você pode usar um pacote externo, por exemplo, o pacote Fluro, que oferece roteamento mais avançado. Ele dá correspondência de padrões com curingas nas rotas, além de análise de query strings em URLs. Provavelmente existem muitos outros pacotes disponíveis, então deixe um comentário com o nome do seu favorito.
Se você está disposto ao desafio, também pode obter rotas dinâmicas usando a propriedade
MaterialApp.onGenerateRoute. Use-a para escrever a lógica de roteamento para quando uma named route não estiver dentro de MaterialApp.routes.
Para cada rota, defina um Path com um padrão RegEx. Se a named route corresponder ao padrão, retorne o widget associado. Em seguida, defina a classe Path para dar suporte a isso:
class Path {
const Path(this.pattern, this.builder);
final String pattern;
final Widget Function(BuildContext, String) builder;
}
Para a página de visão geral e a rota inicial, a implementação é bem simples e parecida com o que você tinha antes. O exemplo a seguir cria um padrão RegEx que corresponde a um slug (letras minúsculas com hífen) usado para encontrar o artigo correspondente:
static List<Path> paths = [
Path(
r'^/article/([\w-]+)$',
(context, match) => Article.getArticlePage(match),
),
Path(
r'^' + OverviewPage.route,
(context, match) => OverviewPage(),
),
Path(
r'^' + HomePage.route,
(context, match) => HomePage(),
),
];
Resta apenas criar uma função onGenerateRoute para MaterialApp. Se a named route atual (settings.name) estiver definida na lista de paths, retorne o widget associado. Não esqueça de passar as correspondências nomeadas no
RegEx (neste exemplo, o slug). Se nenhuma correspondência for encontrada, simplesmente retorne null; WidgetsApp.onUnknownRoute
é chamado para tratar esses casos:
static Route<dynamic> onGenerateRoute(RouteSettings settings) {
for (Path path in paths) {
final regExpPattern = RegExp(path.pattern);
if (regExpPattern.hasMatch(settings.name)) {
final firstMatch = regExpPattern.firstMatch(settings.name);
final match = (firstMatch.groupCount == 1) ? firstMatch.group(1) : null;
return MaterialPageRoute<void>(
builder: (context) => path.builder(context, match),
settings: settings,
);
}
}
// If no match is found, [WidgetsApp.onUnknownRoute] handles it.
return null;
}
Lembre-se de definir a função onGenerateRoute dentro da classe MaterialApp; você implementou URLs dinâmicas com Flutter, usando named routes! Você pode
ver um exemplo interativo completo no DartPad.
Conclusão
Seja qual for a sua escolha, escrever sua própria lógica para rotas ou usar o suporte a rotas que já existe no
MaterialApp, você obtém suporte a URLs por padrão em um app Flutter na web ao usar named routes. Implementar named routes também ajuda a desacoplar a lógica de apresentação da lógica de roteamento, o que resulta em menos duplicação de código.
Conte nos comentários qual solução você usa no seu app, seja escrevendo sua própria lógica ou usando um pacote externo.
Bom código!