GP Coder

Trang chia sẻ kiến thức lập trình Java

  • Java Core
    • Basic Java
    • OOP
    • Exception Handling
    • Multi-Thread
    • Java I/O
    • Networking
    • Reflection
    • Collection
    • Java 8
  • Design pattern
    • Creational Pattern
    • Structuaral Pattern
    • Behavior Pattern
  • Web Service
    • SOAP
    • REST
  • JPA
  • Java library
    • Report
    • Json
    • Unit Test
  • Message Queue
    • ActiveMQ
    • RabbitMQ
  • All
Trang chủ Design pattern Giới thiệu Java Service Provider Interface (SPI) – Tạo các ứng dụng Java dễ mở rộng

Giới thiệu Java Service Provider Interface (SPI) – Tạo các ứng dụng Java dễ mở rộng

Đăng vào 07/05/2019 . Được đăng bởi GP Coder . 8801 Lượt xem . Toàn màn hình

Hầu hết vòng đời của một ứng dụng xoay quanh việc bảo trì. Một ứng dụng có thể mở rộng cho phép bảo trì dễ dàng, tức là nâng cấp một tính năng mà không ảnh hưởng đến toàn bộ ứng dụng. Trong bài viết này chúng ta sẽ tìm hiểu về Java Service Provider Interface (SPI) và cách chúng ta có thể áp dụng nó vào trường hợp sử dụng thực tế để tạo các ứng dụng dễ dàng mở rộng, tạo ứng dụng theo các kiến trúc module, plugin.

Nội dung

  • 1 Các thành phần của Java Service Provider Interface (SPI)
  • 2 Cài đặt và sử dụng SPI

Các thành phần của Java Service Provider Interface (SPI)

Một Service Provider framework là một hệ thống trong đó nhiều nhà cung cấp dịch vụ (Service Provider) implement một Service và hệ thống này cung cấp các implement cho client sử dụng. SPI giúp giảm kết dính và che dấu thông tin giữa các thành phần của ứng dụng.

Java SPI định nghĩa các thành phần chính sau:

  • Service : là một tập hợp các interface/ abstract class mà nó cung cấp quyền truy cập vào một số chức năng hoặc tính năng ứng dụng cụ thể.
  • Service Provider Interface (SPI): là một tập hợp interface/ abstract hoạt động như một proxy hoặc điểm cuối (endpoint) cho service.
  • Service Provider : là một triển khai cụ thể của SPI. Nó chứa một hoặc nhiều class cụ thể implements hoặc extends một Service.
  • ServiceLoader : là thành phần không thể thiếu của SPI. Nó có vai trò tìm kiếm và load các implements khi được yêu cầu. Nó sử dụng context classpath để xác định vị trí các provider implement provider và lưu chúng vào cache để tăng performance.

Cài đặt và sử dụng SPI

Giả sử chúng ta có một ứng dụng cung cấp các service cho các ứng dụng khác sử dụng. Mỗi service của chúng ta có nhiều provider (implementation) khác nhau. Các ứng dụng có thể lựa chọn provider mà nó cần hoặc tự implement một provider khác tuân theo đặc tả của SPI.

Để dễ dàng thêm bớt service mà không ảnh hưởng đến các ứng dụng khác, chúng ta sẽ sử dụng tính năng có sẵn trong Java 6 là ServiceLoader. Hãy xem ví dụ sau:

Đầu tiên, tạo project maven với tên là JavaSPI. Cấu hình file pom.xml như sau:


<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>

	<groupId>com.gpcoder</groupId>
	<artifactId>JavaSPI</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<packaging>jar</packaging>

	<name>JavaSPI</name>
	<url>http://maven.apache.org</url>

	<properties>
		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
		<maven.compiler.source>1.8</maven.compiler.source>
		<maven.compiler.target>1.8</maven.compiler.target>
	</properties>

	<dependencies>
	</dependencies>
</project>

Tiếp theo tạo một Service, chẳng hạn chúng ta cung cấp Serivce hỗ trợ tìm kiếm. Service này chỉ gồm 1 phương thức đơn giản search().

SearchService.java


package com.gpcoder.spi;

import java.util.List;

public interface SearchService {

	List<Result> search(String text);
}

Tiếp theo, chúng ta sẽ tạo các Provider được cung cấp bởi hệ thống:

  • DefaultSearchService : hỗ trợ search thông thường.
  • FullTextSearchService : hỗ trợ search toàn văn.

DefaultSearchService.java


package com.gpcoder.spi;

import java.util.List;

public class DefaultSearchService implements SearchService {

	@Override
	public List<Result> search(String text) {
		System.out.println("DefaultSearchService#search()");
		return null;
	}
}

FullTextSearchService.java


package com.gpcoder.spi;

import java.util.List;

public class FullTextSearchService implements SearchService {

	@Override
	public List<Result> search(String text) {
		System.out.println("FullTextSearchService#search()");
		return null;
	}
}

Để sử dụng SPI, chúng ta cần tạo một file cấu hình:

  • Tên file: là tên đầy đủ của Service, bao gồm cả tên package. Ví dụ: com.gpcoder.spi.SearchService
  • Nội dung file: là tên đầy đủ của Service implement, mỗi implement trên một dòng. Ví dụ: com.gpcoder.spi.DefaultSearchService
    com.gpcoder.spi.FullTextSearchService
  • Vị trí: đặt file này trong thư mục resources/META-INF/services

Cuối cùng, chúng ta sẽ sử dụng ServiceLoader để lấy các Provider đã được đăng ký thông qua cấu hình SPI ở trên:


package com.gpcoder.spi;

import java.util.ServiceLoader;

public class ServiceLoaderExample {
	public static void main(String[] args) {
		System.out.println("App started ");

		ServiceLoader<SearchService> serviceLoader = ServiceLoader.load(SearchService.class);
		for (SearchService provider : serviceLoader) {
			provider.search("");
		}

		System.out.println("App finished ");
	}
}

Output của chương trình:


App started 
DefaultSearchService#search()
FullTextSearchService#search()
App finished 

Đặt trường hợp bây giờ chúng ta có một project khác, cần sử dụng các Service được cung cấp bởi project trên. Tiếp tục, chúng ta tạo một project maven khác tên là JavaSPIChild1 và cấu hình lại file pom.xml như sau:


<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>

	<groupId>com.gpcoder.child1</groupId>
	<artifactId>JavaSPIChild1</artifactId>
	<packaging>jar</packaging>

	<name>JavaSPIChild1</name>
	<url>http://maven.apache.org</url>

	<properties>
		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
		<maven.compiler.source>1.8</maven.compiler.source>
		<maven.compiler.target>1.8</maven.compiler.target>
	</properties>

	<parent>
		<groupId>com.gpcoder</groupId>
		<artifactId>JavaSPI</artifactId>
		<version>0.0.1-SNAPSHOT</version>
		<relativePath>../JavaSPI</relativePath>
	</parent>

	<dependencies>
		<dependency>
			<groupId>com.gpcoder</groupId>
			<artifactId>JavaSPI</artifactId>
			<version>0.0.1-SNAPSHOT</version>
		</dependency>
	</dependencies>
</project>

Tiếp theo chỉnh sửa lại một chút file pom.xml của project JavaSPI, thay đổi packing từ jar thành pom.


<packaging>pom</packaging>

Chi tiết về cách tạo và cấu hình project maven với nhiều module các bạn vui lòng xem lại bài viết: Xây dựng dự án nhiều Module với Maven.

Giả sử trong ứng dụng con này chúng ta cần sử dụng một Provider khác. Chúng ta có thể thực hiện bằng cách tạo một class mới implements từ SearchService.


package com.gpcoder.child1;

import java.util.List;

import com.gpcoder.spi.Result;
import com.gpcoder.spi.SearchService;

public class Child1SearchService implements SearchService {

	@Override
	public List<Result> search(String text) {
		System.out.println("Child1SearchService#search()");
		return null;
	}
}

Để sử dụng SPI, chúng ta cần tạo một file cấu hình com.gpcoder.spi.SearchService trong thư mục resources/META-INF/services như sau:


com.gpcoder.spi.DefaultSearchService
com.gpcoder.child1.Child1SearchService

Lưu ý: chỉ khai báo các Service mà project JavaSPIChild1 cần sử dụng. Trong ví dụ này, chúng ta chỉ sử dụng DefaultSearchService và Child1SearchService.

Bây giờ, chúng ta sẽ sử dụng ServiceLoader để lấy các Provider đã được đăng ký thông qua cấu hình SPI ở trên:


package com.gpcoder.child1;

import java.util.ServiceLoader;

import com.gpcoder.spi.SearchService;

public class Child1ServiceLoaderExample {
	public static void main(String[] args) {
		System.out.println("App started ");
		
		ServiceLoader<SearchService> providers = ServiceLoader.load(SearchService.class);
		for (SearchService provider : providers) {
			provider.search("");
		}

		System.out.println("Child1SearchService: ");
		SearchService service = getServiceByName(Child1SearchService.class.getCanonicalName());
		service.search("");
		
		System.out.println("App finished ");
	}

	public static SearchService getServiceByName(String className) {
		ServiceLoader<SearchService> providers = ServiceLoader.load(SearchService.class);
		for (SearchService provider : providers) {
			if (provider.getClass().getCanonicalName().equals(className)) {
				return provider;
			}
		}
		return null;
	}
}

Output của chương trình:


App started
DefaultSearchService#search()
Child1SearchService#search()
Child1SearchService:
Child1SearchService#search()
App finished

Như bạn thấy, ứng dụng của chúng ta rất dễ dàng thêm/ bớt module mà không cần phải thay đổi hay chỉnh sửa code ở project cha.

Toàn bộ cấu trúc thư mục của project như sau:

 

Tài liệu tham khảo:

  • https://docs.oracle.com/javase/tutorial/ext/basics/spi.html
  • https://docs.oracle.com/javase/6/docs/api/java/util/ServiceLoader.html
  • https://www.baeldung.com/java-spi
  • https://www.developer.com/java/article.php/3848881/Service-Provider-Interface-Creating-Extensible-Java-Applications.htm
5.0
20
Nếu bạn thấy hay thì hãy chia sẻ bài viết cho mọi người nhé! Và Donate tác giả

Shares

Chuyên mục: Design pattern Được gắn thẻ: Design pattern, SPI

Giới thiệu thư viện Apache Commons Chain
Tìm hiểu về Web Service

Có thể bạn muốn xem:

  • Giới thiệu thư viện Apache Commons Chain (01/05/2019)
  • Hướng dẫn Java Design Pattern – Bridge (22/10/2018)
  • Hướng dẫn Java Design Pattern – Strategy (03/01/2019)
  • Hướng dẫn Java Design Pattern – Interpreter (10/12/2018)
  • Hướng dẫn Java Design Pattern – Transfer Object (22/02/2019)

Bình luận

bình luận

Tìm kiếm

Bài viết mới

  • Clean code 13/01/2024
  • Giới thiệu CloudAMQP – Một RabbitMQ server trên Cloud 02/10/2020
  • Kết nối RabbitMQ sử dụng Web STOMP Plugin 19/06/2020
  • Sử dụng publisher confirm trong RabbitMQ 16/06/2020
  • Sử dụng Dead Letter Exchange trong RabbitMQ 13/06/2020

Xem nhiều

  • Hướng dẫn Java Design Pattern – Factory Method (98033 lượt xem)
  • Hướng dẫn Java Design Pattern – Singleton (97681 lượt xem)
  • Giới thiệu Design Patterns (87732 lượt xem)
  • Lập trình đa luồng trong Java (Java Multi-threading) (86400 lượt xem)
  • Giới thiệu về Stream API trong Java 8 (83806 lượt xem)

Nội dung bài viết

  • 1 Các thành phần của Java Service Provider Interface (SPI)
  • 2 Cài đặt và sử dụng SPI

Lưu trữ

Thẻ đánh dấu

Annotation Authentication Basic Java Behavior Pattern Collection Creational Design Pattern Cấu trúc điều khiển Database Dependency Injection Design pattern Eclipse Exception Executor Service Google Guice Gson Hibernate How to Interceptor IO Jackson Java 8 Java Core JDBC JDK Jersey JMS JPA json JUnit JWT Message Queue Mockito Multithreading OOP PowerMockito RabbitMQ Reflection Report REST SOAP Structuaral Pattern Swagger Thread Pool Unit Test Webservice

Liên kết

  • Clean Code
  • JavaTpoint
  • Refactoring Guru
  • Source Making
  • TutorialsPoint
  • W3Schools Online Web Tutorials

Giới thiệu

GP Coder là trang web cá nhân, được thành lập với mục đích lưu trữ, chia sẽ kiến thức đã học và làm việc của tôi. Các bài viết trên trang này chủ yếu về ngôn ngữ Java và các công nghệ có liên quan đến Java như: Spring, JSF, Web Services, Unit Test, Hibernate, SQL, ...
Hi vọng góp được chút ít công sức cho sự phát triển cộng đồng Coder Việt.

Donate tác giả

Tìm kiếm các bài viết của GP Coder với Google Search

Liên hệ

Các bạn có thể liên hệ với tôi thông qua:
  • Trang liên hệ
  • Linkedin: gpcoder
  • Email: contact@gpcoder.com
  • Skype: ptgiang56it

Follow me

Copyright 2025 © GP Coder · All Rights Reserved · Giới thiệu · Chính sách · Điều khoản · Liên hệ ·

Share

Blogger
Delicious
Digg
Email
Facebook
Facebook messenger
Flipboard
Google
Hacker News
Line
LinkedIn
Mastodon
Mix
Odnoklassniki
PDF
Pinterest
Pocket
Print
Reddit
Renren
Short link
SMS
Skype
Telegram
Tumblr
Twitter
VKontakte
wechat
Weibo
WhatsApp
X
Xing
Yahoo! Mail

Copy short link

Copy link