ApiHug Spring Common Extension

Spring Common

Spring extension package that includes basic shared classes and functions, aimed at facilitating faster development:

Source-of-truth note for this page:

• github.com/apihug/skills
• skills/spring-extension

Features

Not enumerating all; generally very intuitive and simple; you can directly refer to the source code during use.

Common

SimpleResultBuilder

The ResponseEntity builder includes:

1. Default functions on the ResponseEntity object
2. Common errors like HttpStatus.TOO_MANY_REQUESTS, with user-friendly interface definition: tooManyRequests
3. Hope defined errors: Error or HopeErrorDetailException

PageableResultBuilder

Supports Pageable ResponseEntity builder, result pre-packaged as a Pageable object, including:

1. pageIndex: Current page number
2. pageSize: Number of objects on this page
3. totalCount: Total count
4. totalPage: Total pages
5. data: List of objects

RuntimeContextInitializer

Runtime context validation and description (RuntimeContext):

1. Assembles runtime: RuntimeContext object
2. Runtime version conflicts, particularly regarding stub dependencies on wire; checks if interface definitions have changed and whether to fail-fast under hope.runtime.check.module configuration set to RESTRICT mode.

Runtime version validation includes:

1. Application version RuntimeContextInitializer.getClass().getPackage().getImplementationVersion() compared with RuntimeContext#getProject.
2. Runtime project RuntimeContext#getProject compared with RuntimeContext#getProto version.
3. Version comparison of dependencies within hope-stub.json.

Util

Audit

Related to security, retrieving the Audit context, including: Identify context account information and Tenant context tenant information, generally derived from HopeContextHolder;

Security

Built-in security framework protocol for Hope;

Identify & Tenant identifiers only support: LONG | STRING | INTEGER and do not support complex or composite types;

The predefined roles include PredefinedRoleCheckerType:

Predefined roles have limited configuration scope; they are suitable for coarse-grained roles involved in your platform. For finer-grained configuration, please use RBAC.

Refer to: ApiHug Spring Security Extensions

checker

The checker package defines the DSL used to express authority and role combinations, but it is not "compile-time only". At runtime, ApiHug loads generated authority metadata, maps it into SecurityContext, and HopeSecurityManager resolves the checker for the current service method before enforcing access rules.

internal

1. Identify context account information and Tenant context tenant information
2. Value types: LONG | STRING | INTEGER

This results in a predefined Customer object with 3*3=9 combinations:

Aspect

Due to the application of Hope, the base code employs code generation technology, so aspects do not require runtime dynamic proxies.

The Aspect protocol class includes only two; in our security framework, there is a SecurityAspect that implements security checks. You can also extend your own, such as for logging or auditing.

Aspects include:

1. type AspectType
2. priority: Higher values indicate higher priority
3. name: Default class name
4. before: Before advice
5. after: After advice
6. exception: Exception advice

AspectType:

Refer

│  PageableResultBuilder.java
│  RuntimeContextInitializer.java
│  SimpleResultBuilder.java
│
├─aspect
│      Aspect.java
│      AspectType.java
│
├─audit
│      AuditContext.java
│      AuditContextSupplier.java
│
├─context
│      CustomerContext.java
│      CustomerContextSupplier.java
│      package-info.java
│
├─security
│  │  AuthorizationToCheckerMapper.java
│  │  Customer.java
│  │  EmptySecurityContext.java
│  │  package-info.java
│  │  QuickCustomerRoleCheckerFactory.java
│  │  SecurityContext.java
│  │  SecurityCustomizer.java
│  │
│  ├─checker
│  │      And.java
│  └─internal
│          CustomerIntegerIdentifyIntegerTenant.java
│          CustomerIntegerIdentifyLongTenant.java
│          CustomerIntegerIdentifyStringTenant.java
│          CustomerLongIdentifyIntegerTenant.java
│          CustomerLongIdentifyLongTenant.java
│          CustomerLongIdentifyStringTenant.java
│          CustomerStringIdentifyIntegerTenant.java
│          CustomerStringIdentifyLongTenant.java
│          CustomerStringIdentifyStringTenant.java
│          ImmutableCustomer.java
│          PredefinedCustomerOption.java
│
└─util
        Helper.java
        NumberUtils.java
        TripleTypes.java