Why modules organize application structure in NestJS - See It in Action

Why modules organize application structure

📖 Scenario: You are building a simple NestJS application to manage books in a library. To keep the code clean and organized, you will use modules to separate different parts of the app.

🎯 Goal: Create a NestJS module called BooksModule that organizes the book-related components. This module will help keep the application structure clear and maintainable.

📋 What You'll Learn

Create a BooksModule using the NestJS @Module decorator

Include an empty BooksService provider in the module

Include an empty BooksController controller in the module

Export the BooksService from the module

💡 Why This Matters

🌍 Real World

In real applications, modules help separate features like users, products, or orders, making the code easier to manage.

💼 Career

Understanding modules is essential for building scalable and maintainable backend applications with NestJS, a popular framework in many companies.

1

Create the BooksService class

Create a class called BooksService with no methods or properties.

NestJS

# Your code here

Hint

Use export class BooksService {} to define the service.

2

Create the BooksController class

Create a class called BooksController with no methods or properties.

NestJS

export class BooksService {
}

# Your code here

Hint

Use export class BooksController {} to define the controller.

3

Create the BooksModule with @Module decorator

Create a class called BooksModule and decorate it with @Module. Inside the decorator, add BooksController to controllers array and BooksService to providers array.

NestJS

export class BooksService {
}

export class BooksController {
}

# Your code here

Hint

Use @Module({ controllers: [BooksController], providers: [BooksService] }) above the BooksModule class.

4

Export BooksService from BooksModule

Add exports array to the @Module decorator and include BooksService so it can be used by other modules.

NestJS

import { Module } from '@nestjs/common';

export class BooksService {
}

export class BooksController {
}

@Module({
  controllers: [BooksController],
  providers: [BooksService],
  # Your code here
})
export class BooksModule {
}

Hint

Add exports: [BooksService] inside the @Module decorator.

Practice

1. Why does NestJS use modules to organize an application?

easy

A. To group related code and keep the app organized

B. To make the app run faster by skipping code

C. To allow direct access to the database without services

D. To replace the need for controllers entirely

Solution

1. Step 1: Understand the purpose of modules in NestJS

   Modules are designed to group related parts of the app, like controllers and services, to keep code organized.

2. Step 2: Identify the correct reason for using modules

   Modules help maintain clear boundaries and structure, making the app easier to manage and scale.

3. Final Answer:

   To group related code and keep the app organized -> Option A

4. Quick Check:

   Modules organize code = A [OK]

Hint: Modules group related code for organization [OK]

Common Mistakes:

• Thinking modules speed up app runtime
• Believing modules replace controllers
• Assuming modules bypass services

2. Which of the following is the correct way to define a module in NestJS?

easy

A. import { Module } from '@nestjs/core'; @Module({ controllers: [], providers: [] }) export class AppModule {}

B. import { Module } from '@nestjs/common'; @Module({ controllers: [], services: [] }) export class AppModule {}

C. import { Module } from '@nestjs/common'; @Module({ components: [], services: [] }) export class AppModule {}

D. import { Module } from '@nestjs/common'; @Module({ controllers: [], providers: [] }) export class AppModule {}

Solution

1. Step 1: Check the import source for Module decorator

   The Module decorator is imported from '@nestjs/common', not '@nestjs/core'.

2. Step 2: Verify the correct properties in the Module decorator

   The correct properties are 'controllers' and 'providers', not 'components' or 'services'.

3. Final Answer:

   import { Module } from '@nestjs/common'; @Module({ controllers: [], providers: [] }) export class AppModule {} -> Option D

4. Quick Check:

   Correct import and properties = B [OK]

Hint: Use '@nestjs/common' and 'providers' in modules [OK]

Common Mistakes:

• Importing Module from '@nestjs/core'
• Using 'components' or 'services' instead of 'providers'
• Mixing up decorators or property names

3. Given this module setup, what will be the output when the app runs?

import { Module, Injectable, Controller, Get } from '@nestjs/common';

@Injectable()
class HelloService {
  getMessage() { return 'Hello from Service'; }
}

@Controller()
class HelloController {
  constructor(private readonly helloService: HelloService) {}
  @Get()
  getHello() { return this.helloService.getMessage(); }
}

@Module({
  controllers: [HelloController],
  providers: [HelloService],
})
export class AppModule {}

medium

A. The app responds with 'HelloController' string

B. The app throws an error because HelloService is missing

C. The app responds with 'Hello from Service' on GET /

D. The app does not start due to missing imports

Solution

1. Step 1: Analyze the service and controller relationship

   HelloController injects HelloService and calls its getMessage method on GET requests.

2. Step 2: Check module declarations

   Both HelloController and HelloService are declared in the module, so dependency injection works correctly.

3. Final Answer:

   The app responds with 'Hello from Service' on GET / -> Option C

4. Quick Check:

   Controller calls service method = A [OK]

Hint: Controllers call services declared in the same module [OK]

Common Mistakes:

• Assuming service is missing from module
• Thinking controller returns its own name
• Believing app fails without extra imports

4. Identify the error in this module definition:

import { Module } from '@nestjs/common';
import { UserService } from './user.service';

@Module({
  controllers: [],
  providers: [UserService],
  exports: [UserService]
})
export class UserModule {}

// In AppModule
@Module({
  imports: [],
  controllers: [],
  providers: []
})
export class AppModule {}

Why can't other modules use UserService?

medium

A. UserService must be declared in controllers, not providers

B. AppModule does not import UserModule, so UserService is not available

C. UserModule should not export UserService

D. UserService is not listed in providers of UserModule

Solution

1. Step 1: Check UserModule exports and providers

   UserService is correctly provided and exported in UserModule.

2. Step 2: Check AppModule imports

   AppModule does not import UserModule, so it cannot access UserService.

3. Final Answer:

   AppModule does not import UserModule, so UserService is not available -> Option B

4. Quick Check:

   Module must import to use exports = D [OK]

Hint: Import modules to access their exported providers [OK]

Common Mistakes:

• Forgetting to import the module that exports the service
• Confusing providers with controllers
• Thinking exports alone share services

5. You want to organize a large NestJS app with features like Users, Products, and Orders. How should you use modules to keep the app scalable and maintainable?

hard

A. Create separate feature modules for Users, Products, and Orders, then import them into a root AppModule

B. Put all controllers and services in a single AppModule to avoid complexity

C. Create modules only for controllers, and keep services global without modules

D. Use modules only for database connections, not for organizing features

Solution

1. Step 1: Understand modular design for large apps

   Large apps benefit from splitting features into separate modules to isolate code and responsibilities.

2. Step 2: Apply modular structure in NestJS

   Create feature modules like UsersModule, ProductsModule, OrdersModule, then import them into AppModule for clear structure and scalability.

3. Final Answer:

   Create separate feature modules for Users, Products, and Orders, then import them into a root AppModule -> Option A

4. Quick Check:

   Feature modules improve scalability = C [OK]

Hint: Split features into modules, import in root module [OK]

Common Mistakes:

• Putting all code in one module causing clutter
• Ignoring services in modular design
• Using modules only for database or ignoring features