Skip to content

LiteGo is a Java-based asynchronous concurrency library. It has a smart executor, which can be freely set the maximum number of concurrent tasks, and the number of threads in waiting queue. It can also set waiting policies and overload strategies.

License

Notifications You must be signed in to change notification settings

applibgroup/ohos-lite-go

Repository files navigation

Build Quality Gate Status

LiteGo

LiteGo is a Java-based asynchronous concurrency library. It has a smart executor, which can be freely set the maximum number of concurrent tasks, and the number of threads in waiting queue. It can also set waiting policies and overload strategies. LiteGo can directly utilise Runnable, Callable, FutureTask and other types of implementations to run a task. Its core component is the "SmartExecutor", which can be used as the sole component in the Application that supports asynchronous concurrency. There can be multiple instances of SmartExecutor in an Application, and each instance has complete "independence", in the sense of independent core concurrency, queuing and waiting indicators, independent task scheduling and waiting list overloading strategy. However, all instances share a thread pool. This mechanism not only meets the independent needs of different modules for thread control and task scheduling, but also shares a pool resource to save overhead, saves resources and reuses threads to the greatest extent, and helps improve performance.

Source

Inspired by the Android library android-lite-go (v1.0) by litesuits:

https://github.com/litesuits/android-lite-go

Features

The number of core concurrent threads can be defined, that is, the number of concurrent requests at the same time.

The number of threads waiting to be queued can be defined, that is, the number of requests that can be queued after exceeding the number of concurrent cores.

The strategy for waiting for the queue to enter the execution state can be defined: first come first, execute first, then execute first.

You can define a strategy for processing new requests after the waiting queue is full:

  • Discard the latest task in the queue
  • Discard the oldest task in the queue
  • Discard the current new task
  • Direct execution (blocking the current thread)
  • Throw an exception (interrupt the current thread)

Dependency

  1. For using LiteGo module in sample app, include the source code and add the below dependencies in entry/build.gradle to generate hap/support.har.
	dependencies {
		implementation project(':ohos_lite_go')
        	testCompile 'junit:junit:4.12'
	}
  1. For using LiteGo module in separate application using har file, add the har file in the entry/libs folder and add the dependencies in entry/build.gradle file.
	dependencies {
		implementation fileTree(dir: 'libs', include: ['*.har'])
		testCompile 'junit:junit:4.12'
	}

  1. For using LiteGo from a remote repository in separate application, add the below dependencies in entry/build.gradle file.
	dependencies {
		implementation 'dev.applibgroup:ohoslitego:1.0.0'
        	testCompile 'junit:junit:4.12'
	}

Usage

Example:

 // Create a SmartExecutor object with default parameters. They are specified in the following lines
 SmartExecutor smartExecutor = new SmartExecutor();

 // Number of concurrent threads at the same time, recommended core size is CPU count
 smartExecutor.setCoreSize(2);

 // adjust maximum capacity of waiting queue by yourself or based on device performance
 smartExecutor.setQueueSize(2);

 // After the number of tasks exceeds Maximum Number of Concurrent tasks (core size), any new tasks
 // automatically enter the Waiting Queue and wait for the completion of the currently executing tasks.
 // After a executing task finishes, a task from the waiting queue enters the execution state according
 // to the strategy: last-in first-run
 smartExecutor.setSchedulePolicy(SchedulePolicy.LAST_IN_FIRST_RUN);

 // When the number of new tasks added subsequently exceeds the maximum capacity of the waiting queue,
 // the overload strategy is executed. In this case, the oldest task in the queue is discarded.
 smartExecutor.setOverloadPolicy(OverloadPolicy.DISCARD_OLD_TASK_IN_QUEUE);

The above code is designed to be able to concurrently run 2 threads at the same time. After the concurrency is fully loaded, the waiting queue can accommodate 2 additional tasks. The oldest tasks in the queue are executed first, and in the case the waiting queue is attempted to be filled beyond its maximum capacity, the oldest task from the queue is discarded.

Test the situation of multiple threads concurrency:

// put in 4 tasks at once
for (int i = 0; i <4; i++) {
    final int j = i;
    smartExecutor.execute(() -> {
        HiLog.info(LABEL, " TASK %{public}d is running now ----------->", j);
        try {
            Thread.sleep(j * (long) 200);
        } catch (InterruptedException e) {
            e.printStackTrace();
            Thread.currentThread().interrupt();
        }
    });
}
// A new task is added to the list, but it is immediately canceled.
Future<?> future = smartExecutor.submit(() -> {
    HiLog.info(LABEL, " TASK 4 will be cancelled ... ------------>");
    try {
        Thread.sleep(1000);
    } catch (InterruptedException e) {
        e.printStackTrace();
        Thread.currentThread().interrupt();
    }
});

// Cancel this task at the right time
future.cancel(false);

In the above code, five tasks of 0, 1, 2, 3, 4 are inserted in sequence at a time. Note that task 4 is the last to be inserted and returns a Future object.

According to the settings, 0 and 1 will be executed immediately. While they are being executed, 2 and 3 will enter the queue. This results in the queue being full, at which point the independently input task 4 will enter. Based on the current overload policy, the oldest task 2 in the queue will be removed, and the queue will consist of only 3 and 4.

Because 4 was subsequently cancelled, it will not completely execute. The final output:

TASK 0 is running now ----------->
TASK 1 is running now ----------->
TASK 3 is running now ----------->

About

LiteGo is a Java-based asynchronous concurrency library. It has a smart executor, which can be freely set the maximum number of concurrent tasks, and the number of threads in waiting queue. It can also set waiting policies and overload strategies.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages