Service locator pattern in Flutter - Practice Problems & Coding Challenges

Challenge - 5 Problems

🧠 Conceptual

intermediate

Understanding the purpose of the Service Locator pattern

What is the main benefit of using the Service Locator pattern in Flutter app testing?

A It replaces the need for unit tests by providing integration tests only.

B It automatically generates UI tests without writing code.

C It centralizes the creation and access of services, making it easier to swap implementations during tests.

D It enforces strict type checking at compile time for all services.

💡 Hint

Think about how managing dependencies helps testing.

The Service Locator pattern centralizes service management, allowing easy replacement of real services with mocks or fakes during testing.

❓ Predict Output

intermediate

Output of service locator registration and retrieval

Given the following Flutter service locator code snippet, what will be printed?

Flutter

final locator = ServiceLocator();

class ApiService {
  String fetchData() => 'Real Data';
}

void main() {
  locator.register<ApiService>(ApiService());
  final api = locator.get<ApiService>();
  print(api.fetchData());
}

A Throws an exception: Service not found

B Real Data

C null

D Instance of 'ApiService'

💡 Hint

Check what fetchData() returns and what is printed.

The ApiService is registered and retrieved correctly, so calling fetchData() returns 'Real Data' which is printed.

❓ assertion

advanced

Correct assertion for mocked service call

In a Flutter test using a service locator, which assertion correctly verifies that the mocked ApiService's fetchData method returns 'Mock Data'?

Flutter

class MockApiService extends Mock implements ApiService {}

void main() {
  final mockApi = MockApiService();
  when(() => mockApi.fetchData()).thenReturn('Mock Data');
  locator.register<ApiService>(mockApi);
  final api = locator.get<ApiService>();
  final result = api.fetchData();
  // Which assertion below is correct?
}

A expect(result, equals('Mock Data'));

B expect(result, isNull);

C expect(result, equals('Real Data'));

D expect(result, isNotEmpty);

💡 Hint

Check what the mock returns and what the assertion compares.

The mock is set to return 'Mock Data', so the assertion must check that result equals 'Mock Data'.

🔧 Debug

advanced

Debugging service locator registration error

Why does the following Flutter test code throw an exception when trying to retrieve a service?

Flutter

final locator = ServiceLocator();

class ApiService {}

void main() {
  final api = locator.get<ApiService>();
  print(api);
}

A Because ApiService was never registered before calling get, causing a 'Service not found' error.

B Because locator.get requires an async call which is missing.

C Because ApiService class is missing a default constructor.

D Because print cannot output class instances directly.

💡 Hint

Check if the service was registered before retrieval.

The error occurs because the service locator has no registered instance of ApiService when get is called.

❓ framework

expert

Best practice for resetting service locator in Flutter tests

In Flutter testing, what is the best way to ensure the service locator is clean before each test to avoid state leakage?

A Do nothing; service locator state does not affect tests.

B Create a new service locator instance inside each test without resetting.

C Rely on Flutter's hot reload to clear the locator state automatically.

D Call locator.reset() or equivalent method in the setUp() function before each test.

💡 Hint

Think about test isolation and shared state.

Resetting the service locator before each test ensures no leftover services interfere with other tests, maintaining isolation.

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