Service locator pattern in Flutter

Introduction

The service locator pattern helps you find and use services or objects easily in your app without passing them everywhere. It keeps your code clean and simple.

When you want to share a single instance of a service across many parts of your app.

When you want to avoid passing objects through many layers of widgets or classes.

When you want to easily swap or mock services during testing.

When you want to organize your app dependencies in one place.

When you want to reduce tight coupling between classes.

Syntax

Flutter

final locator = GetIt.instance;

// Register a service
locator.registerLazySingleton<Service>(() => ServiceImplementation());

// Use the service
final service = locator<Service>();

Use registerLazySingleton to create the service only when needed.

Use locator() to get the registered service anywhere in your code.

Examples

This example registers a Logger service as a singleton and uses it to log a message.

Flutter

final locator = GetIt.instance;

// Register a service
locator.registerSingleton<Logger>(Logger());

// Access the service
final logger = locator<Logger>();
logger.log('App started');

This example registers ApiService lazily, so it is created only when first used.

Flutter

final locator = GetIt.instance;

// Register a service lazily
locator.registerLazySingleton<ApiService>(() => ApiServiceImpl());

// Later in the code
final api = locator<ApiService>();
api.fetchData();

Sample App

This test shows how the service locator provides the same CounterService instance everywhere. Incrementing count from one reference affects the other.

Flutter

import 'package:get_it/get_it.dart';

class CounterService {
  int count = 0;
  void increment() => count++;
}

void main() {
  final locator = GetIt.instance;

  // Register the CounterService
  locator.registerLazySingleton<CounterService>(() => CounterService());

  // Get the service and use it
  final counter1 = locator<CounterService>();
  counter1.increment();
  counter1.increment();

  // Get the service again
  final counter2 = locator<CounterService>();

  print('Counter1 count: ${counter1.count}');
  print('Counter2 count: ${counter2.count}');

  // Check if both are the same instance
  print('Same instance: ${identical(counter1, counter2)}');
}

Important Notes

Always register services before using them to avoid errors.

Use service locator carefully to avoid hiding dependencies, which can make testing harder.

For testing, you can replace services in the locator with mock versions easily.

Summary

The service locator pattern helps manage and access shared services easily.

It reduces the need to pass objects through many layers.

It supports better testing by allowing easy swapping of services.

Practice

1. What is the main purpose of the Service Locator Pattern in Flutter testing?

easy

A. To handle user input events

B. To create UI widgets dynamically

C. To provide a centralized way to access shared services without passing them manually

D. To manage app navigation routes

Solution

1. Step 1: Understand the role of service locator

   The service locator pattern provides a central place to get instances of services needed across the app.

2. Step 2: Compare with other options

   Creating UI widgets, handling input, and managing navigation are unrelated to service locator's purpose.

3. Final Answer:

   To provide a centralized way to access shared services without passing them manually -> Option C

4. Quick Check:

   Service locator = centralized service access [OK]

Hint: Service locator centralizes service access, not UI or navigation [OK]

Common Mistakes:

• Confusing service locator with UI widget creation
• Thinking it manages navigation or input events
• Assuming it replaces dependency injection completely

2. Which of the following is the correct way to register a service using the GetIt service locator in Flutter?

easy

A. GetIt.instance.create<MyService>();

B. GetIt.instance.registerSingleton<MyService>(MyService());

C. GetIt.instance.addService(MyService());

D. GetIt.register<MyService>();

Solution

1. Step 1: Recall GetIt registration syntax

   GetIt uses registerSingleton<T>(instance) to register a singleton service.

2. Step 2: Check each option

   GetIt.instance.registerSingleton<MyService>(MyService()); matches the correct syntax. Options A, B, and C use invalid or non-existent methods.

3. Final Answer:

   GetIt.instance.registerSingleton<MyService>(MyService()); -> Option B

4. Quick Check:

   Register singleton with registerSingleton() [OK]

Hint: Use registerSingleton() to add services in GetIt [OK]

Common Mistakes:

• Using non-existent methods like addService or create
• Omitting the instance when registering
• Confusing registerSingleton with registerFactory

3. Given the following code using GetIt, what will be the output of print(service.getData());?

class MyService {
  String getData() => "Hello from Service";
}

final getIt = GetIt.instance;

void main() {
  getIt.registerSingleton<MyService>(MyService());
  var service = getIt<MyService>();
  print(service.getData());
}

medium

A. Instance of 'MyService'

B. null

C. Error: Service not found

D. Hello from Service

Solution

1. Step 1: Understand service registration and retrieval

   The service MyService is registered as a singleton and then retrieved correctly.

2. Step 2: Analyze the method call

   Calling getData() returns the string "Hello from Service" as defined.

3. Final Answer:

   Hello from Service -> Option D

4. Quick Check:

   Registered service returns expected string [OK]

Hint: Registered service returns its method output directly [OK]

Common Mistakes:

• Assuming print shows the instance reference
• Forgetting to register the service before use
• Expecting null if service is registered

4. Identify the error in this Flutter test setup using GetIt:

final getIt = GetIt.instance;

void setup() {
  getIt.registerSingleton<MyService>(MyService());
}

void main() {
  setup();
  getIt.registerSingleton<MyService>(MyService());
}

medium

A. Registering the same service twice causes an exception

B. Missing await keyword for async registration

C. Service instance is not created properly

D. GetIt instance is not initialized

Solution

1. Step 1: Review service registration calls

   The service MyService is registered twice without unregistering first.

2. Step 2: Understand GetIt behavior on duplicate registration

   GetIt throws an exception if the same service is registered twice without reset or unregister.

3. Final Answer:

   Registering the same service twice causes an exception -> Option A

4. Quick Check:

   Duplicate registration = exception [OK]

Hint: Avoid double registering services without unregistering [OK]

Common Mistakes:

• Assuming async await is needed for registration
• Thinking service instance creation is faulty
• Believing GetIt needs explicit initialization

5. You want to write a test in Flutter that uses the service locator pattern to swap a real service with a mock. Which approach correctly achieves this?

hard

A. Unregister the real service, then register the mock service before the test runs

B. Register both real and mock services with the same type simultaneously

C. Create a new instance of the real service inside the test without using the locator

D. Use the real service and ignore mocking for simplicity

Solution

1. Step 1: Understand service swapping in tests

   To replace a service with a mock, you must unregister the original service first.

2. Step 2: Register the mock service before test execution

   Registering the mock after unregistering ensures the locator returns the mock during tests.

3. Final Answer:

   Unregister the real service, then register the mock service before the test runs -> Option A

4. Quick Check:

   Unregister real, register mock = swap services [OK]

Hint: Unregister real service before registering mock in tests [OK]

Common Mistakes:

• Registering both real and mock services for same type
• Not unregistering real service before mock
• Ignoring service locator and creating instances manually