ip2region-spring-boot-starter

Spring Boot Starter for ip2region

简体中文 | English

Positioning · Capabilities · Dependency · Quick Start · Configuration · Versions · Build · License

---

Current Version：2.0.2-SNAPSHOT
JDK Baseline：17
Group ID：io.github.easy4j
Artifact ID：ip2region-spring-boot-starter
License：Apache License 2.0

1. Positioning

ip2region-spring-boot-starter is a Spring Boot starter that integrates ip2region for applications using ip2region. It provides auto-configuration, property binding, and ready-to-use beans so that applications can consume ip2region capabilities with minimal setup.

Dimension	Description
Type	Spring Boot Starter
Consumers	Spring Boot applications using ip2region
Core Capabilities	auto-configuration, property binding, ready-to-use beans for ip2region
JDK	17
Coordinates	io.github.easy4j:ip2region-spring-boot-starter:2.0.2-SNAPSHOT
Config Prefix	ip2region

2. Core Capabilities

Capability	Status	Description
Auto-configuration	✅ Stable	Registers ip2region beans automatically
Property Binding	✅ Stable	Binds ip2region.* to IP2regionProperties
XdbSearcher bean	✅ Stable	Auto-registered via IP2regionAutoConfiguration

3. Requirements and Compatibility

Dependency	Minimum	Evidence
JDK	17	pom.xml
Spring Boot	2.6.0	pom.xml parent
Maven	3.6+	Maven Enforcer

4. Auto-configuration

The starter auto-configures the following beans:

Bean	Condition	Missing Behavior
XdbSearcher	classpath + property	not created
IP2regionTemplate	classpath + property	not created

Auto-configuration registration:

• META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports (Spring Boot 2.7+ / 3.x / 4.x)
• META-INF/spring.factories (Spring Boot 2.x legacy)

5. Dependency

<dependency>
    <groupId>io.github.easy4j</groupId>
    <artifactId>ip2region-spring-boot-starter</artifactId>
    <version>2.0.2-SNAPSHOT</version>
</dependency>

No additional easy4j component dependencies.

6. Quick Start

6.1 Add dependency

Add the dependency above to your pom.xml.

6.2 Configure

ip2region:
  enabled: true

6.3 Use the bean

@SpringBootApplication
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

Then inject the auto-configured bean in your code:

@Autowired
private XdbSearcher xdbSearcher;

7. Configuration Reference

7.1 Config Prefix

ip2region

7.2 Configuration Items

Property	Type	Default	Required	Description	Sensitive
ip2region.enabled	boolean	true	No	Enable the starter	No

8. Version Lines and Compatibility

Branch	JDK	Spring Boot	Component Version	Status
2.3.x / 2.7.x	8+	2.3.x / 2.7.x	1.0.x	Maintenance
3.0.x ~ 3.5.x	17	3.x	2.0.x	Maintenance
4.0.x / 4.1.x	17+	4.x	3.0.x	Active

9. Build and Test

mvn clean verify
mvn -pl ip2region-spring-boot-starter -am test

10. Troubleshooting

Symptom	Diagnosis	Resolution
Bean not created	Check auto-configuration report	Verify ip2region.enabled=true and classpath
ClassNotFoundException	Missing dependency	Add the required module
Version conflict	mvn dependency:tree	Use BOM for version alignment

11. Contribution

1. Fork the repository.
2. Create a feature branch.
3. Run mvn clean verify before submitting.
4. Submit a pull request.

12. License

This project is licensed under the Apache License, Version 2.0.

---

Back to top · Issues · Repository