Thực hành sử dụng Annotations và Code Generation

dart create practice_gen
cd practice_gen

name: practice_gen
description: A practical guide to code generation.
version: 1.0.0
 
environment:
  sdk: '>=3.0.0 <4.0.0'
 
# Phần chạy app
dependencies:
  # Không cần thư viện ngoài nào ở đây
 
# Phần sinh mã (Compile time)
dev_dependencies:
  build: ^2.4.1           # Nền tảng build của Dart
  build_runner: ^2.4.6    # Công cụ chạy các script code gen
  source_gen: ^1.4.0      # Thư viện hỗ trợ viết Generator dễ dàng hơn

// lib/hello_annotation.dart
 
/// Class định nghĩa annotation @Hello
class Hello {
  final String name;
 
  // Bắt buộc phải là const constructor
  const Hello(this.name);
}

// lib/hello_generator.dart
import 'package:analyzer/dart/element/element.dart';
import 'package:build/build.dart';
import 'package:source_gen/source_gen.dart';
import 'hello_annotation.dart';
 
class HelloGenerator extends GeneratorForAnnotation<Hello> {
  // Hàm này sẽ tự động được gọi mỗi khi tìm thấy 1 class có gắn @Hello
  @override
  String generateForAnnotatedElement(
      Element element, ConstantReader annotation, BuildStep buildStep) {
 
    // 1. Kiểm tra: Chúng ta chỉ muốn gắn @Hello lên một Class
    if (element is! ClassElement) {
      throw InvalidGenerationSourceError(
        '@Hello chỉ có thể sử dụng trên class.',
        element: element,
      );
    }
 
    // 2. Lấy dữ liệu từ file code của người dùng
    // Lấy giá trị của biến 'name' đã truyền vào @Hello('World')
    final nameValue = annotation.peek('name')?.stringValue ?? 'Unknown';
    
    // Lấy tên class người dùng đang gắn annotation
    final className = element.name;
 
    // 3. Trả về đoạn code (dưới dạng String) mà ta muốn tự động sinh ra
    // Ở đây ta sinh ra một biến String toàn cục (global)
    return '''
      // Code tự động sinh ra cho class $className
      const String hello${className}Message = "Hello, $nameValue!! Welcome to Code Generation!";
    ''';
  }
}
 
// Cấu hình Builder (hàm khởi tạo entry point để build_runner gọi tới)
Builder helloBuilder(BuilderOptions options) =>
    SharedPartBuilder([HelloGenerator()], 'hello_generator');

# build.yaml
targets:
  $default:
    builders:
      practice_gen|hello_builder:
        enabled: true
 
builders:
  # Tên builder tuỳ ý
  hello_builder:
    # Trỏ đến file generator và hàm helloBuilder ở bước 3
    import: "package:practice_gen/hello_generator.dart"
    builder_factories: ["helloBuilder"]
    build_extensions: { ".dart": [".g.dart"] }
    auto_apply: dependents
    build_to: cache
    applies_builders: ["source_gen|combining_builder"]

// lib/main.dart
import 'hello_annotation.dart';
 
// 1. Bắt buộc: Cần declare part file tự sinh 
part 'main.g.dart';
 
// 2. Gắn Annotation
@Hello('Bumbii')
class MyClass {
  void doWork() {
    print('Vào việc thôi...');
  }
}
 
void main() {
  MyClass().doWork();
  
  // 3. Sử dụng biến được sinh ra tự động
  // (Biến này sẽ báo lỗi đỏ lúc chưa chạy build_runner)
  print(helloMyClassMessage); 
}

dart run build_runner build

[INFO] Succeeded after 1.2s with 1 outputs (2 actions)

// GENERATED CODE - DO NOT MODIFY BY HAND
 
part of 'main.dart';
 
// **************************************************************************
// HelloGenerator
// **************************************************************************
 
// Code tự động sinh ra cho class MyClass
const String helloMyClassMessage =
    "Hello, Bumbii!! Welcome to Code Generation!";

dart run lib/main.dart

Vào việc thôi...
Hello, Bumbii!! Welcome to Code Generation!