Skip to content

Latest commit

 

History

History
280 lines (151 loc) · 9.18 KB

README.md

File metadata and controls

280 lines (151 loc) · 9.18 KB

vrml-logo

查看 中文文档.

VRML is a set of common extension tools based on Java 8, designed to provide more robust and easy to use common tools to solve common problems in the workplace.

It provides monitoring metrics, logging components, network request agents, error code design specifications, alarms and event listening, and more.

VRML provides elegant and powerful solutions to the problems you might encounter in a common scenario in these jobs.

The usage environment is mainly integrated with Spring, based on Spring to implement the mechanism of dynamic interface discovery, but also provides non-Spring custom configuration functions.

VRML is built primarily on the Spring library (and other commonly used libraries), and the coding references the functional style of VAVR.

Because VRML provides a modular mechanism, you can easily refer to the functionality you need in your classpath, or import all using -all.

To stay up to date, Please follow the blog.

Vrml API

The core concept of VRML design is the same as Cloud-Runtimes API design concept.

That is, a set of unrelated APIs such as frame / platform / specific implementation is defined, and the interface is programmed, thereby obtaining better expansion and cross-platform characteristics.

Compared to the Cloud-Runtimes-API language-independent design idea, VRML is mainly designed for JVM programming language, so in the API design combines Java characteristics and Spring's usage.

The concept of API programming determines: VRML can be integrated in different platforms, different framework systems, you can enjoy the feature of Write, Run Anywhere.

Vrml With Cloud-Runtimes API

Please refer to VRML-CloudRuntimes

Combine the VRML API with the Cloud-Runtimes API:

  • Ability to implement VRML Config by Cloud-Runtimes Config
  • Ability to implement VRML RPC by Cloud-Runtimes RPC
  • ...

This way, you can use VRML's capabilities on any Cloud-Runtimes support, for example:

  • CAPA
  • Layotto
  • DAPR
  • ...

Vrml With Custom API

You can implement the VRML API directly using the specific platform / framework system.

This allows you to use VRML in a specific platform / frame system.


Modules

Build Status

WIKI

An alert API that supports multiple methods for vrml library


Build Status

WIKI

A Aspect to log request process for vrml library


Build Status

The adaptor of statistical triggering, and different Runnable operations can be performed based on statistical indicators.


Build Status

It encapsulates Spring's Bean operations and provides some basic tools such as: safe log printing, mark annotations, etc.


Build Status

A common data structure extension API for vrml library


Build Status

WIKI

A set of error code definition specifications for vrml library


Build Status

A publish event API for vrml library


Build Status

Other auxiliary tools library


Operation encapsulation of Java JMX.


Build Status

WIKI

A API to log by the key for vrml library


Build Status

WIKI

A API to record application's metrics data for vrml library


Maven related operation tool class.


Build Status

Netty helper utils for vrml library


Reactor Reactive library extension tool set.


Java reflection extension toolset.


Build Status

WIKI

A proxy API to wrap remote request with log/record/check/... for vrml library


Build Status

Java File utils for vrml library


JVM Shutdown extension tool set.


Build Status

Java SPI utils for vrml library


Extended Stop Watch execution monitor.


Build Status

WIKI

Different Runnable can be executed conveniently according to the switches configuration, avoiding a lot of if-else switches logic.


Build Status

WIKI

A time API with timezone/cron for vrml library


An extended toolset for the Tomcat container.


Build Status

WIKI

A api of MDC/MAP traces for vrml library


Maven

You can import all vrml modules:

<dependency>
    <groupId>group.rxcloud</groupId>
    <artifactId>vrml</artifactId>
    <version>1.1.4</version>
    <type>pom</type>
    <scope>import</scope>
</dependency>

Latest feature branch:

<dependency>
    <groupId>group.rxcloud</groupId>
    <artifactId>vrml</artifactId>
    <version>1.1.4</version>
    <type>pom</type>
    <scope>import</scope>
</dependency>

Contributing

A small number of users have reported problems building vrml. Read our contribution guide for details.