i69n은 Dart와 Flutter용 가벼운 국제화 패키지로, 번역을 관리하기 위해 YAML 파일을 사용하고 소스 코드 생성을 활용하여 타입 안전한 컴파일 시점 검사를 제공합니다. 개발자가 구조화된 YAML 파일에 언어 문자열을 정의할 수 있도록 하여 쉽게 접근할 수 있는 Dart 코드를 자동으로 생성함으로써 로컬라이제이션을 간소화합니다. 이 패키지는 Android, iOS, Web, macOS, Windows, Linux 등 여러 플랫폼을 지원하며, 강력하면서도 간단한 번역 워크플로우가 필요한 크로스플랫폼 앱에 적합합니다.
사용 사례
다국어 앱 지원
정적 번역 관리
타입 안전한 문자열 접근
크로스 플랫폼 로컬라이제이션
CI/CD 통합
개발자 친화적인 번역 워크플로우
주요 기능
YAML 기반 번역 파일
소스 코드 생성
형 안전한 번역 액세스
컴파일 시 검증
최소한의 보일러플레이트
모든 주요 플랫폼 지원
적합한 대상
간단한 i18n이 필요한 Flutter 프로젝트
YAML을 통해 번역을 관리하는 팀
컴파일 시 안전성을 원하는 개발자
다양한 언어를 대상으로 하는 앱
엄격한 CI/CD 파이프라인을 가진 프로젝트
소규모에서 중간 규모의 현지화 필요성
고려 사항
코드 생성 단계가 필요합니다
YAML 파일 관리 오버헤드
제한된 런타임 언어 전환
동적 또는 서버 기반 번역에 적합하지 않음
변경 후 생성된 파일을 수동으로 업데이트해야 합니다
정적 번역 세트에 가장 적합
원본 README
연결된 소스 저장소의 README 원문 스냅샷입니다. 최신 내용은 저장소에서 확인하세요.
Simple internationalization (i18n) package for Dart and Flutter.
class ExampleMessages {
const ExampleMessages();
ButtonExampleMessages get button => ButtonExampleMessages(this);
UsersExampleMessages get users => UsersExampleMessages(this);
}
class ButtonExampleMessages {
final ExampleMessages _parent;
const ButtonExampleMessages(this._parent);
String get save => "Save";
String get load => "Load";
}
class UsersExampleMessages {
final ExampleMessages _parent;
const UsersExampleMessages(this._parent);
String get logout => "Logout";
String welcome(String name) => "Hello $name!";
}
... and use them in your code - plain and simple.
ExampleMessages m = ExampleMessages();
print(m.users.welcome('World'));
// outputs: Hello World!
Package is an extension (custom builder) for build_runner
(Dart standard for source generation) and it can be used with Flutter, AngularDart
or any other type of Dart project.
i69n: 51 points simpler than your standard i18n!
The official Dart/Flutter approach to i18n seems to be ... complicated and kind of ... heavyweight.
I would like my messages to be checked during compile time. Is that message really there?
Key to the localized message shouldn't be just some arbitrary String, it should be a getter method!
And if the message takes some parameters, it should be a method which take those parameters!
How to use with Flutter
Create YAML file with your messages, for example:
lib/messages/foo.i69n.yaml
generic:
done: Done
ok: OK
invoice:
create: Create an invoice
delete: Delete this invoice
Add translations for different languages:
lib/messages/foo_cs.i69n.yaml (_cs = Czech translation)
generic:
done: Hotovo
# ok is the same and Foo_cs extends Foo.
invoice:
create: Vytvořit fakturu
delete: Smazat fakturu
Add build_runner as a dev_dependency and i69n as a dependency to pubspec.yaml:
dependencies:
flutter:
sdk: flutter
i69n: any
...
dev_dependencies:
build_runner: any
flutter_test:
sdk: flutter
Open a terminal and in the root of your Flutter project run:
flutter packages pub run build_runner watch --delete-conflicting-outputs
... and keep it running. Your message classes will appear next to YAML files and will be
rebuilt automatically each time you change the source YAML.
For one-time (re)build of your messages run:
flutter packages pub run build_runner build --delete-conflicting-outputs
Import generated messages and use them:
import 'packages:my_app/messages/foo.i69n.dart'
...
Foo m = Foo();
return Text(m.bar);
...
You are using webdev tool already, so you just need to add i69n
as a dependency and that's all.
Parameters and pluralization
The implementation is VERY straightforward, which allows you to do all sorts of crazy stuff:
invoice:
create: Create invoice
delete: Delete invoice
help: "Use this function
to generate new invoices and stuff.
Awesome!"
count(int cnt): "You have created $cnt ${_plural(cnt, one:'invoice', many:'invoices')}."
apples:
_apples(int cnt): "${_plural(cnt, one:'apple', many:'apples')}"
count(int cnt): "You have eaten $cnt ${_apples(cnt)}."
Now see the generated classes:
class ExampleMessages {
const ExampleMessages();
InvoiceExampleMessages get invoice => InvoiceExampleMessages(this);
ApplesExampleMessages get apples => ApplesExampleMessages(this);
}
class InvoiceExampleMessages {
final ExampleMessages _parent;
const InvoiceExampleMessages(this._parent);
String get create => "Create invoice";
String get help => "Use this function to generate new invoices and stuff. Awesome!";
String get delete => "Delete invoice";
String count(int cnt) => "You have created $cnt ${_plural(cnt, one:'invoice', many:'invoices')}.";
}
class ApplesExampleMessages {
final ExampleMessages _parent;
const ApplesExampleMessages(this._parent);
String _apples(int cnt) => "${_plural(cnt, one:'apple', many:'apples')}";
String count(int cnt) => "You have eaten $cnt ${_apples(cnt)}.";
}
See how you can reuse the pluralization of _apples(int cnt)? (!!!)
There are three functions you can use in your message:
How to decide what translation to use (ExampleMessages_cs?, ExampleMessages_hu?) is up to you.
The package simply generates message classes, that's all.
Where and how to store instances of these message classes -
again, up to you. I would consider ScopedModel for Flutter and registering
messages instance into dependency injection in AngularDart.
But in this case a singleton would be acceptable also.
Customization and speacial features
Support for regions
You might need to support multiple regions for one language. Use common locale names as file suffixes:
It's still useful to access your messages using the String keys in some cases. For example when the key
of the message is composed dynamically at runtime, maybe like this:
var vehicleTypeMessageKey = "VehicleType.${data['type']'}";
In case the key doesn't exist, an exception is thrown:
...
throw Exception('Message $key doesn\'t exist in $this');
You can disable this behaviour by adding flag 'nothrow':
_i69n: nothrow
generic:
done: Done
ok: OK
This flag is inherited to the lower levels of messages structure.
In some rare cases you might want to 'disable' this map generation (maybe to enable better tree-shaking of unused messages?).
In such case use a simple flag 'nomap':
generic:
_i69n: nomap
done: Done
ok: OK
No message in 'generic' message group will be accessible through the [] operator. Scope of the flag is very narrow - one message object
in one file. Flag is not inherited into lower levels of messages and in
most cases you want to repeat it in all translations files to make an impact.
Global configuration for map operators
For large projects with many translation files, you can configure nomap and notraverse flags globally through build.yaml:
Both flags: Both messages['hello'] and messages['nested.message'] fail
Escaping special characters
i69n uses double quotes in generated source files. Unless you need to use double quotes in your string,
you should be fine.
message: Let's go!
...
String get message => "Let's go!";
Only "\t", "\r" and "\n" characters are automatically escaped by i69n.
message: "Let's\ngo!" // quotes needed by YAML, \n is converted to new line by YAML
...
String get message => "Let's\ngo!"; // new line escaped by i69n -> result is the same string
If you need to disable escaping, use "noescape" flag.
_i69n: noescape
message: Let's go!
Escaping the details of escaping
These are a few examples of more complicated strings in which you might need to add a backslash here and there:
problematic: "Hello \\\"world\\\"!"
// ^^^ yes, tripple backslash
lessProblematic: 'Hello \"world\"!'
// ^ use single quotes in YAML, add only one backslash for Dart
alsoProblematic(int count): "${_plural(count, zero:'didn\\'t find any tasks', other: 'found some tasks')}"
// ^ here
Please prefer single quotes inside pluralization functions.
But in most cases you will be fine. Just observe generated classes and maybe experiment a little bit.
More configuration flags
So far only 'noescape' and 'nomap'. If you need both, separate them with comma.
_i69n: noescape,nomap
Custom pluralization
The package can correctly decide between 'one', 'few', 'many', etc. only for
English and Czech (for now). But you can easily plug your own language,
see example/main.dart
and Czech and English
implementation.
If you implement support for your language, please let me know,
I'll gladly embed it into the package: tomucha@gmail.com
Language of the default file
The default file (the one without language code in the file name) is supposed to be in English (meaning English locales are used in pluralization functions). You can change that by adding a 'language' to the file:
_i69n_language: de
generic:
done: Erledigt
ok: OK
The '_i69n_language' flag is only meaningful on the first line of the default file, there is no reason to use it anywhere else.
Custom imports and custom types
It might be usefull to teach your message objects some tyep control, for example:
friends:
michael:
name: Michael Friend
description: My good friend.
eva:
name: Eva Friend
description: My not so good friend.
It's obvious that 'friends' should implement some kind of interface so you can work with them in a type-safe way. You can achieve that by adding a 'implements' flag:
friends:
michael:
_i69n_implements: MyFriendInterface
name: Michael Friend
description: My good friend.
eva:
_i69n_implements: MyFriendInterface
name: Eva Friend
description: My not so good friend.
In most case it should be enough to add 'implements' flag in the default messages file only.
And you will probably need to import that interface. Just put 'import' flag at the beginning of the file: