ohayolibs/docs/module.en-US.md

Ohayo is a set of essential modules for ohayojp.

---
order: 30
title:
  en-US: Module Guidelines
  zh-CN: 模块注册指导原则
type: Other
---

The `AppModule`, `CoreModule`, and `SharedModule` modules have not been used very clearly, and it is easy to use them. The goal of the Angular module is to make components, instructions, services, and pipeline function blocks more cohesive, and each functional area forms a separate set of business domains or utilities.

## 1) Classification description

------------

### AppModule

The root module is used to guide Angular startup. It is very suitable for importing some modules that need to be used everywhere in the application. Such as: theme system, user master authentication module, permission module, global HTTP interceptors, international services, etc..

### CoreModule

The core module will only be imported once. It is equivalent to `AppModule`, but we should treat it as a **pure service class module**. For example: message, data access, etc.

### SharedModule

We call it a shared module. It should not have `providers` because `ShareModule` will be imported in all business modules. Which will cause the service to be overwritten.

## 2) Recommendation

------------

### AppModule

**Should** import module:

+ Angular Module: `BrowserModule`, `BrowserAnimationsModule`, `HttpClientModule`
+ `OhayoThemeModule` Theme system
+ `OhayoMockModule` Mock data
+ `OhayoAuthModule` User authentication module
+ `OhayoACLModule` Privilege module
+ Internationalization module

**Should** include services:

+ Angular globalization
+ HTTP interceptor
+ Angular start service
+ `ng-zorro-antd` Basic component service
+ `@ohayo/components` Business component service

**Role:** Throughout the definition of the entire application.

------------

### CoreModule

**Should** only leave the `providers` attribute.

**Role:** Some common services. such as: user messages, HTTP data access.

------------

### ShareModule

**Should** contain definitions:

+ Apply generic custom business components

**Should** import module:

+ Angular generic module:`CommonModule`、`FormsModule`、`RouterModule`、`ReactiveFormsModule`
+ `ng-zorro-antd` Basic component module
+ `@ohayo/components` Business component module
+ Third-party generic dependency component module

**Should** Export all included modules.

**Should not** have `providers` attribute.

**Function:** Some common custom, third-party component definitions, reducing the import of business modules.

------------

### Business module

The business module should include a business definition module and a routing module.

**Should** import module:

+ `SharedModule`
+ Corresponding routing module

**Should not**:

+ Export any component
+ Try not to use the `providers` attribute

**Route module**

**Should** include only the `import`, `exports` modules of the route.