这是 IPinfo.io IP 地址 API 的官方 Java 客户端库，允许您查找自己的 IP 地址，或获取 IP 的以下任何

# [<img src="https://ipinfo.io/static/ipinfo-small.svg" alt="IPinfo" width="24"/>](https://ipinfo.io/) IPinfo Java Client Library [](LICENSE) This is the official Java client library for the [IPinfo.io](https://ipinfo.io) IP address API, allowing you to lookup your own IP address, or get any of the following details for an IP: - [IP geolocation data](https://ipinfo.io/ip-geolocation-api) (city, region, country, postal code, latitude and longitude) - [ASN information](https://ipinfo.io/asn-api) (ISP or network operator, associated domain name, and type, such as business, hosting or company) - [Company data](https://ipinfo.io/ip-company-api) (the name and domain of the business that uses the IP address) - [Carrier details](https://ipinfo.io/ip-carrier-api) (the name of the mobile carrier and MNC and MCC for that carrier if the IP is used exclusively for mobile traffic) Check all the data we have for your IP address [here](https://ipinfo.io/what-is-my-ip). ### Getting Started You'll need an IPinfo API access token, which you can get by singing up for a free account at [https://ipinfo.io/signup](https://ipinfo.io/signup). The free plan is limited to 50,000 requests per month, and doesn't include some of the data fields such as IP type and company data. To enable all the data fields and additional request volumes see [https://ipinfo.io/pricing](https://ipinfo.io/pricing) [Click here to view the Java SDK's API documentation](https://ipinfo.github.io/java/). #### Installation ##### Maven Add these values to your pom.xml file: Dependency: ```xml <dependencies> <dependency> <groupId>io.ipinfo</groupId> <artifactId>ipinfo-api</artifactId> <version>2.1</version> <scope>compile</scope> </dependency> </dependencies> ``` #### Quick Start ##### IP Information ````java import io.ipinfo.api.IPinfo; import io.ipinfo.api.errors.RateLimitedException; import io.ipinfo.api.model.IPResponse; public class Main { public static void main(String... args) { IPinfo ipInfo = new IPinfo.Builder() .setToken("YOUR TOKEN") .build(); try { IPResponse response = ipInfo.lookupIP("8.8.8.8"); // Print out the hostname System.out.println(response.getHostname()); } catch (RateLimitedException ex) { // Handle rate limits here. } } } ```` ##### ASN Information ````java import io.ipinfo.api.IPinfo; import io.ipinfo.api.errors.RateLimitedException; import io.ipinfo.api.model.IPResponse; public class Main { public static void main(String... args) { IPinfo ipInfo = new IPinfo.Builder() .setToken("YOUR TOKEN") .build(); try { ASNResponse response = ipInfo.lookupASN("AS7922"); // Print out country name System.out.println(response.getCountry()); } catch (RateLimitedException ex) { // Handle rate limits here. } } } ```` #### Errors - `ErrorResponseException`: A runtime exception accessible through the `ExecutionException` of a future. This exception signals that something went wrong when mapping the API response to the wrapper. You probably can't recover from this exception. - `RateLimitedException` An exception signalling that you've been rate limited. #### Caching This library provides a very simple caching system accessible in `SimpleCache`. Simple cache is an in memory caching system that resets every time you restart your code. If you prefer a different caching methodology, you may use the `Cache` interface and implement your own caching system around your own infrastructure. The default cache length is 1 day, this can be changed by calling the SimpleCache constructor yourself. ```java import io.ipinfo.api.IPinfo; import io.ipinfo.api.errors.RateLimitedException; import io.ipinfo.api.model.IPResponse; public class Main { public static void main(String... args) { // 5 Day Cache IPinfo ipInfo = new IPinfo.Builder() .setToken("YOUR TOKEN") .setCache(new SimpleCache(Duration.ofDays(5))) .build(); try { IPResponse response = ipInfo.lookupIP("8.8.8.8"); // Print out the hostname System.out.println(response.getHostname()); } catch (RateLimitedException ex) { // Handle rate limits here. } } } ``` #### Country Name Lookup This library provides a system to lookup country names through ISO2 country codes. By default, this translation exists for English (United States). If you wish to provide a different language mapping, just use the following system in the builder: ```java import io.ipinfo.api.IPinfo; import io.ipinfo.api.errors.RateLimitedException; import io.ipinfo.api.model.IPResponse; public class Main { public static void main(String... args) { IPinfo ipInfo = new IPinfo.Builder() .setToken("YOUR TOKEN") .setCountryFile(new File("path/to/file.json")) .build(); try { IPResponse response = ipInfo.lookupIP("8.8.8.8"); // Print out the country code System.out.println(response.getCountryCode()); // Print out the country name System.out.println(response.getCountryName()); } catch (RateLimitedException ex) { // Handle rate limits here. } } } ``` This file must follow the same layout as seen [here](https://github.com/ipinfo/java-ipinfo/blob/master/src/main/resources/en_US.json) More language files can be found [here](https://country.io/data) #### EU Country Lookup This library provides a system to lookup if a country is a member of the European Union (EU) through ISO2 country codes. By default, [here](https://github.com/ipinfo/java-ipinfo/blob/master/src/main/resources/eu.json) is the file containing all the EU members. If you wish to provide a different file, just use the following system in the builder: ```java import io.ipinfo.api.IPinfo; import io.ipinfo.api.errors.RateLimitedException; import io.ipinfo.api.model.IPResponse; public class Main { public static void main(String... args) { IPinfo ipInfo = new IPinfo.Builder() .setToken("YOUR TOKEN") .setEUCountryFile(new File("path/to/file.json")) .build(); try { IPResponse response = ipInfo.lookupIP("8.8.8.8"); // Print out whether the country is a member of the EU System.out.println(response.isEU()); } catch (RateLimitedException ex) { // Handle rate limits here. } } } ``` #### Internationalization This library provides a system to lookup if a country is a member of the European Union (EU), emoji and unicode of country's flag, code and symbol of country's currency, public link to the country's flag image as an SVG and continent code and name through ISO2 country codes. Following are the file that are loaded by default: - [eu.json](https://github.com/ipinfo/java-ipinfo/blob/master/src/main/resources/eu.json) - [flags.json](https://github.com/ipinfo/java-ipinfo/blob/master/src/main/resources/flags.json) - [currency.json](https://github.com/ipinfo/java-ipinfo/blob/master/src/main/resources/currency.json) - [continent.json](https://github.com/ipinfo/java-ipinfo/blob/master/src/main/resources/continent.json) If you wish to provide a different file, just use the following system in the builder: ```java import io.ipinfo.api.IPinfo; import io.ipinfo.api.errors.RateLimitedException; import io.ipinfo.api.model.IPResponse; public class Main { public static void main(String... args) { IPinfo ipInfo = new IPinfo.Builder() .setToken("YOUR TOKEN") .setEUCountryFile(new File("path/to/file.json