This article will help existing users understand LoopBack 4:
- How to connect LoopBack 3.x concepts to LoopBack 4 terms
- What’s new and exciting in LoopBack 4
Overview
At high-level, LoopBack 3.x applications consist of three big “parts”
- Persistence layer (this includes talking to backend services like SOAP/REST)
- Outwards facing REST API
- App-wide setup - Express middleware, boot scripts, etc.
In the persistence layer, users can contribute the following artifacts:
- Definitions of Model data types (properties, validations)
- Definition of data sources
- Configuration of models (which datasource are they attached to)
- Operation hooks
At the public API side, users can define:
- Which built-in methods should be exposed (think of
disableRemoteMethodByName) - Custom remote methods
- before/after/afterError hooks at application-level
- before/after/afterError hooks at model-level
- before/after/afterError hooks at model method level
LoopBack 4 was intentionally designed to allow users to choose their own
ORM/persistence solution. The juggler from LoopBack 3 has been packaged into
@loopback/repository so that it’s possible for users to reuse their existing
model definitions, migrating their application incrementally.
Concept/feature mapping
Note: See the GitHub issue for a full list of features that have not been migrated to LoopBack 4.
In Loopback 3.x (and earlier), models were responsible for both accessing data in other systems (databases, SOAP services, etc.) and providing the application’s external REST API. This made it easy to quickly build a REST interface for an existing database, but difficult to customize the REST API and fine-tune it to the needs of application clients.
LoopBack 4 is moving to the well-known Model-(View-)Controller pattern, where the code responsible for data access and manipulation is separated from the code responsible for implementing the REST API.
loopback4-example-microservices demonstrates this loose coupling. Facade is the top-level service that serves the account summary API, and is dependent on the three services Account, Customer, and Transaction. But the facade only aggregates the calls to the three services, and is not tightly coupled with the service implementation; that’s why it is independent of the three services. We can define the APIs in facade the way we want. Thus, code responsible for data access and manipulation is separated from the code responsible for implementing client side APIs.
| Concept/Feature | LoopBack 3.x | LoopBack 4 |
|---|---|---|
| Programming Language | Built with JavaScript ES5 Node.js callbacks |
Modern TypeScript with latest JavaScript features
Promises & async/await, ES2016/2017 and beyond |
| Core foundation | Express with LoopBack extensions | Home-grown IoC container |
| Tooling | loopback-cli and API Connect UI |
@loopback/cli |
| Model Definition | Models can be defined with JavaScript or JSON | Models can be defined with TypeScript;
TBD: JavaScript - see loopback-next#560 |
| Model Persistence | A model can be attached to a datasource backed by a connector that implements CRUD operations | Repositories are introduced to represent persistence related operations; a repository binds a model metadata to a datasource |
| Model Relation | Relations can be defined between models | Relations can be defined between models; queries and persistence are implemented at repository level |
| Model Remoting | JavaScript/JSON remoting metadata is used to describe method signatures
and their mapping to REST/HTTP
Swagger specs are generated after the fact |
Remoting metadata can be supplied by OpenAPI JSON/YAML documents or generated automatically through TypeScript decorators |
| API Spec | Swagger 2.0 | OpenAPI Spec v3 and potentially other API specs such as GraphQL, gRPC, etc. |
| API Explorer | Built-in UI based on swagger-ui v2 (/explorer) |
Built-in UI based on swagger-ui v3 (/explorer) |
| DataSource | JSON | TypeScript and JSON;
TBD: JavaScript - see loopback-next#560 |
| Connectors | Plain JavaScript, ES5 with callbacks | Plain JavaScript, ES5 with callbacks;
TBD: TypeScript with async/await - see loopback-next#889 |
| Mixins | Use a utility to add methods from the mixin to the target model class | Use ES2015 mixin classes pattern supported by TypeScript 2.2 and above |
| Middleware | Express middleware with phase-based registration and ordering | Sequence consisting of actions;
TBD: support for Express middleware, see loopback-next#1293 and loopback-next#2035. |
| Boot script | Scripts to be invoked during bootstrapping | Life cycle events and observers |
| Remote hooks | Before/After hooks for remote methods | Interceptors |
| CRUD operation hooks | Hooks for CRUD operations | (TBD) |
| Built-in models | Built-in User/AccessToken/Application/ACL/Role/RoleMapping for AAA | (TBD) |
| Authentication | User model as the login provider loopback-component-passport |
Authentication component with extensibility to strategy providers |
| Authorization | Use built-in User/Application/AccessToken model for identity and ACL/Role/RoleMapping for authorization | Authorization component (work in progress). |
| Component | A very simple implementation to configure and invoke other modules | A fully-fledged packaging model that allows contribution of extensions from other modules |
| Storage component | loopback-compontent-storage
|
not available |
| Push notifications | loopback-component-push
|
not available |
| OAuth 2.0 provider | loopback-component-oauth2
|
(TBD) |
| 3rd-party logins via Passport | loopback-component-passport
|
@loopback/authentication-passport
|
| Offline synchronization | Synchronization component (EXPERIMENTAL) | not available |
| Client SDKs | AngularJS (1.x), Android, iOS, Xamarin, Isomorphic JavaScript |
OpenAPI code generators, e.g.
swagger-codegen,
openapi-generator or
ng-openapi-gen
|
What’s new and exciting in LoopBack 4
Some of the highlights of LoopBack 4 include:
- Leverage TypeScript for better code quality and productivity
- Unify and simplify the asynchronous programming model/style around Promise and Async/Await
- Implement an IoC Container with Dependency Injection for better visibility, extensibility and composability
- Introduce Component as packaging model for extensions that can be plugged into LoopBack 4 applications
- Make everything else as components (REST, Authentication, and Authorization)
- Divide the responsibilities of LoopBack models into
- Controllers: handle incoming API requests
- Repositories: provide access to datasources
- Models: define schemas for business objects
- Services: interact with existing REST APIs, SOAP Web Services, and other forms of services/microservices
- Refactor the ORM into separate modules for different concerns (TBD)
As LoopBack 4 continues to grow, more features are continuously added. You can check out our blog to keep up with these new features.