如何用java调用网站的API，获得json文件，并且简单解析它？

1. 背景

因为在学校做一个Web项目，需要在前台和后台都调用reddit网站的API，获得json文件，前台获取json可以借助Ajax来实现，后台java获取json文件不是很了解，所以上网查了资料，注意这里由于调用的都是该网站的数据，所以都是使用get方法发送请求的，还有post方法，一般用来上传资料例如评论，这里没有讨论。这里把使用get方法和注意事项在这里总结一下。

2. 发送请求获取json文件的方法

其实向网站服务器使用get发送请求json文件的方法，与使用get方法请求html文件的方式是一样的。只是服务器返回的文件不同罢了。

主要步骤如下：

1. 建立和URL之间的链接

2. 设置请求的属性（注意：user-agent这个属性在这里必须设置）

3. 建立连接

4. 使用输入流来读取URL的响应（也可以使用map来读取header信息）

5. 将获得的结果转化为JSONObject，便于之后的解析

代码如下：

import net.sf.json.JSONObject;

import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.net.URL;
import java.net.URLConnection;

public class Test {
    /**
     * 向指定URL发送GET方法的请求
     *
     * @param url
     *            发送请求的URL
     * @param param
     *            请求参数，请求参数应该是 name1=value1&name2=value2 的形式。
     * @return URL 所代表远程资源的响应结果
     */
    public static JSONObject sendGet(String url, String param) {
        JSONObject jsonObject = null;
        String result = "";
        BufferedReader in = null;
        try {
            String urlNameString = url + "?" + param;
            URL realUrl = new URL(urlNameString);
            // 打开和URL之间的连接
            URLConnection connection = realUrl.openConnection();
            // 设置通用的请求属性
            connection.setRequestProperty("accept", "*/*");
            connection.setRequestProperty("connection", "Keep-Alive");
            connection.setRequestProperty("user-agent",
                    "Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1;SV1)");
            connection.setRequestProperty("Expires", "0");
            // 建立实际的连接
            connection.connect();
//            // 获取所有响应头字段
//            Map<String, List<String>> map = connection.getHeaderFields();
//            // 遍历所有的响应头字段
//            for (String key : map.keySet()) {
//                System.out.println(key + "--->" + map.get(key));
//            }
            // 定义 BufferedReader输入流来读取URL的响应
            in = new BufferedReader(new InputStreamReader(
                    connection.getInputStream()));
            String line;
            while ((line = in.readLine()) != null) {
                result += line;
            }
            jsonObject = JSONObject.fromObject(result);
        } catch (Exception e) {
            System.out.println("发送GET请求出现异常！" + e);
            e.printStackTrace();
        }
        // 使用finally块来关闭输入流
        finally {
            try {
                if (in != null) {
                    in.close();
                }
            } catch (Exception e2) {
                e2.printStackTrace();
            }
        }
        return jsonObject;
    }

    public static void main(String[] args) {
        //发送 GET 请求
        JSONObject jsonFile = Test.sendGet("https://www.reddit.com/hot.json", "");
        System.out.println("kind:" + jsonFile.getString("kind"));
    }
}

这里只对JSONObject进行了简单的解析，其实解析解释根据需要调用不同的get方法。

结果为

/Library/Java/JavaVirtualMachines/jdk1.8.0_121.jdk/Contents/Home/bin/java -Didea.launcher.port=7536 "-Didea.launcher.bin.path=/Applications/IntelliJ IDEA.app/Contents/bin" -Dfile.encoding=UTF-8 -classpath "/Library/Java/JavaVirtualMachines/jdk1.8.0_121.jdk/Contents/Home/jre/lib/charsets.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_121.jdk/Contents/Home/jre/lib/deploy.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_121.jdk/Contents/Home/jre/lib/ext/cldrdata.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_121.jdk/Contents/Home/jre/lib/ext/dnsns.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_121.jdk/Contents/Home/jre/lib/ext/jaccess.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_121.jdk/Contents/Home/jre/lib/ext/jfxrt.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_121.jdk/Contents/Home/jre/lib/ext/localedata.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_121.jdk/Contents/Home/jre/lib/ext/nashorn.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_121.jdk/Contents/Home/jre/lib/ext/sunec.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_121.jdk/Contents/Home/jre/lib/ext/sunjce_provider.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_121.jdk/Contents/Home/jre/lib/ext/sunpkcs11.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_121.jdk/Contents/Home/jre/lib/ext/zipfs.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_121.jdk/Contents/Home/jre/lib/javaws.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_121.jdk/Contents/Home/jre/lib/jce.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_121.jdk/Contents/Home/jre/lib/jfr.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_121.jdk/Contents/Home/jre/lib/jfxswt.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_121.jdk/Contents/Home/jre/lib/jsse.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_121.jdk/Contents/Home/jre/lib/management-agent.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_121.jdk/Contents/Home/jre/lib/plugin.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_121.jdk/Contents/Home/jre/lib/resources.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_121.jdk/Contents/Home/jre/lib/rt.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_121.jdk/Contents/Home/lib/ant-javafx.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_121.jdk/Contents/Home/lib/dt.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_121.jdk/Contents/Home/lib/javafx-mx.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_121.jdk/Contents/Home/lib/jconsole.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_121.jdk/Contents/Home/lib/packager.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_121.jdk/Contents/Home/lib/sa-jdi.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_121.jdk/Contents/Home/lib/tools.jar:/Users/yilu/Workspace/Java EE workspace/parsejson/out/production/parsejson:/Users/yilu/Workspace/Java EE workspace/parsejson/json-lib.jar:/Users/yilu/Workspace/Java EE workspace/parsejson/commons-lang-2.6/commons-lang-2.6.jar:/Users/yilu/Workspace/Java EE workspace/parsejson/commons-lang-2.6/commons-lang-2.6-javadoc.jar:/Users/yilu/Workspace/Java EE workspace/parsejson/commons-lang-2.6/commons-lang-2.6-sources.jar:/Users/yilu/Workspace/Java EE workspace/parsejson/ezmorph-0.8.1.jar:/Users/yilu/Workspace/Java EE workspace/parsejson/commons-logging-1.2/commons-logging-1.2.jar:/Users/yilu/Workspace/Java EE workspace/parsejson/commons-logging-1.2/commons-logging-1.2-javadoc.jar:/Users/yilu/Workspace/Java EE workspace/parsejson/commons-collections-3.2.2/commons-collections-3.2.2.jar:/Users/yilu/Workspace/Java EE workspace/parsejson/commons-collections-3.2.2/commons-collections-3.2.2-javadoc.jar:/Users/yilu/Workspace/Java EE workspace/parsejson/commons-beanutils-1.9.3/commons-beanutils-1.9.3.jar:/Users/yilu/Workspace/Java EE workspace/parsejson/commons-beanutils-1.9.3/commons-beanutils-1.9.3-tests.jar:/Users/yilu/Workspace/Java EE workspace/parsejson/commons-beanutils-1.9.3/commons-beanutils-1.9.3-javadoc.jar:/Users/yilu/Workspace/Java EE workspace/parsejson/commons-beanutils-1.9.3/commons-beanutils-1.9.3-sources.jar:/Users/yilu/Workspace/Java EE workspace/parsejson/commons-beanutils-1.9.3/commons-beanutils-1.9.3-test-sources.jar:/Applications/IntelliJ IDEA.app/Contents/lib/idea_rt.jar" com.intellij.rt.execution.application.AppMain Test
kind:Listing

Process finished with exit code 0

3. 注意事项：

不要以为这样就万事大吉了，这里需要注意的是，在java中，当要把结果json文件以JSONObject的方式返回的话，要额外引入6个包。（如果以String方式返回则不需要，不过返回String没什么意义）

6个包如下：

(1) json-lib.jar

(2) ezmorph-0.8.1.jar

(3) commons-lang-2.6

(4) commons-logging-1.2

(5) commons-collections-3.2.2

(6) commons-beanutils-1.9.3

版本的注意：这里博主曾经因为使用了其中几个版本较新的包而引发过错误，后来查了网上的解决办法，也就是使用老版本的包。所以出现错误时，可以看一下是不是包的版本问题。这里提供的版本的经过测试是可以使用的。