search
HomeJavajavaTutorialA brief introduction to the Java spi mechanism

Recently I have seen that some of the company's frameworks and some of the open source frameworks I have seen before use java's spi mechanism for service discovery and access.

So briefly summarize the ideas of java spi mechanism.

There are often many different implementation solutions for each abstract module in our system, such as the solution for the log module, xmlThe solution for the parsing module, the jdbc module, etc. In object-oriented design, we generally recommend that modules be programmed based on interface, and implementation classes should not be hard-coded between modules. Once a specific implementation class is involved in the code, it violates the principle of pluggability. If an implementation needs to be replaced, the code needs to be modified.

In order to realize that the module can be assembled without dynamically specifying it in the program, a service discovery mechanism is needed. Java SPI provides such a mechanism: a mechanism to find service implementations for a certain interface. It is somewhat similar to the idea of ​​​​IOC, which is to move the control of assembly outside the program. This mechanism is especially important in modular design.

The specific agreement of java spi is as follows:

When the service provider provides an implementation of the service interface, in the META-INF/services of the jar package A file named after the service interface is also created in the / directory. This file contains the specific implementation class that implements the service interface. When an external program assembles this module, it can find the specific implementation class name through the configuration file in the jar package META-INF/services/, and load the instantiation to complete the module injection.

Based on such a convention, the implementation class of the service interface can be found very well without the need to formulate it in the code.

jdk provides a tool class for service implementation lookup: java.util.ServiceLoader

Example

1.common-logging

The earliest log facade interface provided by apache. Only interface, no implementation. The specific solution is implemented by each provider. It is found that the log provider scans the META-INF/services/org.apache.commons.logging.LogFactory configuration file and reads the file. Find the content of the log mentioning the industrial and commercial implementation class. As long as our log implementation includes this file and formulates the implementation class of LogFactory factory interface in the file.

2.jdbc

Before jdbc4.0, developers still needed to be based on Class.forName("xxx") to load driver, jdbc4 also uses the spi mechanism to discover the driver provider, you can use the META-INF/services/java.sql.Driver file There is a way to specify the implementation class to expose the driver provider.

3. Write a simple example by yourself

Suppose there is a contentsearch system, which is divided into two modules: display and search. Display and search are based on interface programming. The implementation of search may be based on file system search, or it may be based on database search. The example code is as follows

Search.java: Search interface

package search;  
  
import java.util.List;  
  
import definition.Doc;  
  
public interface Search {  
    List<Doc> search(String keyword);  
}

FileSearch.java: File system search implementation

package search;  
  
import java.util.List;  
  
import definition.Doc;  
  
public class FileSearch implements Search {  
  
    @Override  
    public List<Doc> search(String keyword) {  
        System.out.println("now use file system search. keyword:" + keyword);  
        return null;  
    }  
  
}

DatabaseSearch.java

package search;  
  
import java.util.List;  
  
import definition.Doc;  
  
public class DatabaseSearch implements Search {  
  
    @Override  
    public List<Doc> search(String keyword) {  
        System.out.println("now use database search. keyword:" + keyword);  
        return null;  
    }  
  
}

SearchTest.java

package search;  
  
import java.util.Iterator;  
import java.util.ServiceLoader;  
  
public class SearchTest {  
  
    public static void main(String[] args) {  
        ServiceLoader<Search> s = ServiceLoader.load(Search.class);  
        Iterator<Search> searchs = s.iterator();  
        if (searchs.hasNext()) {  
            Search curSearch = searchs.next();  
            curSearch.search("test");  
        }  
    }  
}

Finally created in the META-INF/services/search.Search file.

When the search.Search file content is "search.FileSearch", the program output is:

now use file system search. keyword:test

When the search.Search file content is "search.DatabaseSearch", the program output is:

now use database search. keyword:test

It can be seen that there is no code related to the specific implementation in SearchTest, but is based on the spi mechanism to find the implementation of the service

The above is the detailed content of A brief introduction to the Java spi mechanism. For more information, please follow other related articles on the PHP Chinese website!

Statement
The content of this article is voluntarily contributed by netizens, and the copyright belongs to the original author. This site does not assume corresponding legal responsibility. If you find any content suspected of plagiarism or infringement, please contact admin@php.cn
How does IntelliJ IDEA identify the port number of a Spring Boot project without outputting a log?How does IntelliJ IDEA identify the port number of a Spring Boot project without outputting a log?Apr 19, 2025 pm 11:45 PM

Start Spring using IntelliJIDEAUltimate version...

How to elegantly obtain entity class variable names to build database query conditions?How to elegantly obtain entity class variable names to build database query conditions?Apr 19, 2025 pm 11:42 PM

When using MyBatis-Plus or other ORM frameworks for database operations, it is often necessary to construct query conditions based on the attribute name of the entity class. If you manually every time...

How to use the Redis cache solution to efficiently realize the requirements of product ranking list?How to use the Redis cache solution to efficiently realize the requirements of product ranking list?Apr 19, 2025 pm 11:36 PM

How does the Redis caching solution realize the requirements of product ranking list? During the development process, we often need to deal with the requirements of rankings, such as displaying a...

How to safely convert Java objects to arrays?How to safely convert Java objects to arrays?Apr 19, 2025 pm 11:33 PM

Conversion of Java Objects and Arrays: In-depth discussion of the risks and correct methods of cast type conversion Many Java beginners will encounter the conversion of an object into an array...

How do I convert names to numbers to implement sorting and maintain consistency in groups?How do I convert names to numbers to implement sorting and maintain consistency in groups?Apr 19, 2025 pm 11:30 PM

Solutions to convert names to numbers to implement sorting In many application scenarios, users may need to sort in groups, especially in one...

E-commerce platform SKU and SPU database design: How to take into account both user-defined attributes and attributeless products?E-commerce platform SKU and SPU database design: How to take into account both user-defined attributes and attributeless products?Apr 19, 2025 pm 11:27 PM

Detailed explanation of the design of SKU and SPU tables on e-commerce platforms This article will discuss the database design issues of SKU and SPU in e-commerce platforms, especially how to deal with user-defined sales...

How to set the default run configuration list of SpringBoot projects in Idea for team members to share?How to set the default run configuration list of SpringBoot projects in Idea for team members to share?Apr 19, 2025 pm 11:24 PM

How to set the SpringBoot project default run configuration list in Idea using IntelliJ...

See all articles

Hot AI Tools

Undresser.AI Undress

Undresser.AI Undress

AI-powered app for creating realistic nude photos

AI Clothes Remover

AI Clothes Remover

Online AI tool for removing clothes from photos.

Undress AI Tool

Undress AI Tool

Undress images for free

Clothoff.io

Clothoff.io

AI clothes remover

Video Face Swap

Video Face Swap

Swap faces in any video effortlessly with our completely free AI face swap tool!

Hot Tools

SecLists

SecLists

SecLists is the ultimate security tester's companion. It is a collection of various types of lists that are frequently used during security assessments, all in one place. SecLists helps make security testing more efficient and productive by conveniently providing all the lists a security tester might need. List types include usernames, passwords, URLs, fuzzing payloads, sensitive data patterns, web shells, and more. The tester can simply pull this repository onto a new test machine and he will have access to every type of list he needs.

DVWA

DVWA

Damn Vulnerable Web App (DVWA) is a PHP/MySQL web application that is very vulnerable. Its main goals are to be an aid for security professionals to test their skills and tools in a legal environment, to help web developers better understand the process of securing web applications, and to help teachers/students teach/learn in a classroom environment Web application security. The goal of DVWA is to practice some of the most common web vulnerabilities through a simple and straightforward interface, with varying degrees of difficulty. Please note that this software

SAP NetWeaver Server Adapter for Eclipse

SAP NetWeaver Server Adapter for Eclipse

Integrate Eclipse with SAP NetWeaver application server.

MinGW - Minimalist GNU for Windows

MinGW - Minimalist GNU for Windows

This project is in the process of being migrated to osdn.net/projects/mingw, you can continue to follow us there. MinGW: A native Windows port of the GNU Compiler Collection (GCC), freely distributable import libraries and header files for building native Windows applications; includes extensions to the MSVC runtime to support C99 functionality. All MinGW software can run on 64-bit Windows platforms.

Safe Exam Browser

Safe Exam Browser

Safe Exam Browser is a secure browser environment for taking online exams securely. This software turns any computer into a secure workstation. It controls access to any utility and prevents students from using unauthorized resources.