1、使用场景
最近在使用apisix项目（一个API网关开源项目），其中涉及到使用curl命令发送Json数据到etcd数据库，使用curl命令举例如下：
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 |
curl http://127.0.0.1:9080/apisix/admin/routes/oa1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d ' { "uris": [ "oa1" ], "name": "CertService_Make_EndsideCert_PerHardCert", "methods": [ "GET", "POST", "PUT", "DELETE", "PATCH", "HEAD", "OPTIONS", "CONNECT", "TRACE" ], "plugins": { "jwt-auth": { "disable": true }, "proxy-rewrite": { "scheme": "http", "uri": "/CertService/Make/EndsideCert/PerHardCert" } }, "upstream_id": "default", "status": 1 }' |
上面命令中：
- url是：http://127.0.0.1:9080/apisix/admin/routes/oa1；
- header是：'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1'，其中-H是提示这是Header部分；
- body就是-d后面的内容了；
2、编写put发送方法
使用的是Okhttputils包类，具体源代码如下：
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 |
import okhttp3.*; import okhttp3.logging.HttpLoggingInterceptor; import org.apache.commons.lang3.StringUtils; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import javax.net.ssl.*; import java.io.IOException; import java.security.SecureRandom; import java.security.cert.CertificateException; import java.security.cert.X509Certificate; import java.util.Iterator; import java.util.Map; import java.util.concurrent.TimeUnit; /** * */ public class OkHttpUtils { private static Logger LOG = LoggerFactory .getLogger(OkHttpUtils.class); public final static long READ_TIMEOUT = 120L; public final static long CONNECT_TIMEOUT = 60L; public final static long WRITE_TIMEOUT = 60L; public static final MediaType JSON = MediaType.parse("application/json; charset=utf-8"); private static final byte[] LOCKER = new byte[0]; private static OkHttpUtils mInstance; private OkHttpClient mOkHttpClient; private OkHttpUtils() { okhttp3.OkHttpClient.Builder ClientBuilder = new okhttp3.OkHttpClient.Builder().followRedirects(false);; HttpLoggingInterceptor loggingInterceptor = new HttpLoggingInterceptor(); //包含header、body数据 loggingInterceptor.setLevel(HttpLoggingInterceptor.Level.BODY); //在build OkHttpClient的时候加入Log拦截器 //ClientBuilder.addInterceptor(loggingInterceptor); ClientBuilder.readTimeout(READ_TIMEOUT, TimeUnit.SECONDS);//读取超时 ClientBuilder.connectTimeout(CONNECT_TIMEOUT, TimeUnit.SECONDS);//连接超时 ClientBuilder.writeTimeout(WRITE_TIMEOUT, TimeUnit.SECONDS);//写入超时 //支持HTTPS请求，跳过证书验证 ClientBuilder.sslSocketFactory(createSSLSocketFactory()); ClientBuilder.hostnameVerifier(new HostnameVerifier() { @Override public boolean verify(String hostname, SSLSession session) { return true; } }); mOkHttpClient = ClientBuilder.build(); mOkHttpClient.dispatcher().setMaxRequests(300); mOkHttpClient.dispatcher().setMaxRequestsPerHost(100); } /** * 单例模式获取NetUtils * * @return */ public static OkHttpUtils getInstance() { if (mInstance == null) { synchronized (LOCKER) { if (mInstance == null) { mInstance = new OkHttpUtils(); } } } return mInstance; } /** * get请求，同步方式，获取网络数据，是在主线程中执行的，需要新起线程，将其放到子线程中执行 * * @param url * @return */ public Response getData(String url) { return getData(url, null); } /** * get请求，同步方式，获取网络数据，是在主线程中执行的，需要新起线程，将其放到子线程中执行 * * @param url * @return */ public Response getData(String url, Map<String, String> headerParams) { //1 构造Request Request.Builder builder = new Request.Builder(); if (headerParams!=null && headerParams.size() > 0) { builder.headers(Headers.of(headerParams)); } Request request = builder.get().url(url).build(); //2 将Request封装为Call Call call = mOkHttpClient.newCall(request); //3 执行Call，得到response Response response = null; try { response = call.execute(); } catch (IOException e) { e.printStackTrace(); } return response; } /** * post请求，同步方式，提交数据，是在主线程中执行的，需要新起线程，将其放到子线程中执行 * * @param url * @param bodyParams * @return */ public Response putData(String url, Map<String, String> bodyParams, Map<String, String> headerParams) { //1构造RequestBody RequestBody body = setRequestBody(bodyParams); //2 构造Request Request.Builder requestBuilder = new Request.Builder(); if (headerParams!=null && headerParams.size() > 0) { requestBuilder.headers(Headers.of(headerParams)); } Request request = requestBuilder.put(body).url(url).build(); //3 将Request封装为Call Call call = mOkHttpClient.newCall(request); //4 执行Call，得到response Response response = null; try { response = call.execute(); } catch (IOException e) { if (e instanceof java.net.SocketException) { LOG.error("java.net.SocketException occur: Maybe Socket Closed!!!"); } else { e.printStackTrace(); } } return response; } /** * post请求，同步方式，提交数据，是在主线程中执行的，需要新起线程，将其放到子线程中执行 * * @param url * @param bodyParams * @return */ public Response postData(String url, Map<String, String> bodyParams, Map<String, String> headerParams, String tag) { //1构造RequestBody RequestBody body = setRequestBody(bodyParams); //2 构造Request Request.Builder requestBuilder = new Request.Builder(); if (!StringUtils.isEmpty(tag)) { requestBuilder.tag(tag); } if (headerParams!=null && headerParams.size() > 0) { requestBuilder.headers(Headers.of(headerParams)); } Request request = requestBuilder.post(body).url(url).build(); //3 将Request封装为Call Call call = mOkHttpClient.newCall(request); //4 执行Call，得到response Response response = null; try { response = call.execute(); } catch (IOException e) { if (e instanceof java.net.SocketException) { LOG.error("java.net.SocketException occur: Maybe Socket Closed!!!"); } else { e.printStackTrace(); } } return response; } /** * post请求，同步方式，提交数据，是在主线程中执行的，需要新起线程，将其放到子线程中执行 * * @param url * @param bodyParams * @return */ public Response postData(String url, Map<String, String> bodyParams, Map<String, String> headerParams) { return postData(url, bodyParams, headerParams, null); } /** * post请求，同步方式，提交数据，是在主线程中执行的，需要新起线程，将其放到子线程中执行 * * @param url * @param bodyParams * @return */ public Response postData(String url, Map<String, String> bodyParams) { return postData(url, bodyParams, null); } /** * get请求，异步方式，获取网络数据，是在子线程中执行的，需要切换到主线程才能更新UI * * @param url * @param myNetCall * @return */ public void getDataAsyn(String url, final MyNetCall myNetCall) { //1 构造Request Request.Builder builder = new Request.Builder(); Request request = builder.get().url(url).build(); //2 将Request封装为Call Call call = mOkHttpClient.newCall(request); //3 执行Call call.enqueue(new Callback() { @Override public void onFailure(Call call, IOException e) { myNetCall.failed(call, e); } @Override public void onResponse(Call call, Response response) throws IOException { myNetCall.success(call, response); } }); } /** * post请求，异步方式，提交数据，是在子线程中执行的，需要切换到主线程才能更新UI * * @param url * @param bodyParams * @param myNetCall */ public void postDataAsyn(String url, Map<String, String> bodyParams, Map<String, String> headerParams, String tag, final MyNetCall myNetCall) { //1构造RequestBody RequestBody body = setRequestBody(bodyParams); //2 构造Request Request.Builder requestBuilder = new Request.Builder(); if (!StringUtils.isEmpty(tag)) { requestBuilder.tag(tag); } if (headerParams!=null && headerParams.size() > 0) { requestBuilder.headers(Headers.of(headerParams)); } Request request = requestBuilder.post(body).url(url).build(); //3 将Request封装为Call Call call = mOkHttpClient.newCall(request); //4 执行Call final long st = System.currentTimeMillis(); call.enqueue(new Callback() { @Override public void onFailure(Call call, IOException e) { myNetCall.failed(call, e); } @Override public void onResponse(Call call, Response response) throws IOException { long et = System.currentTimeMillis(); System.out.println("response time: " + (et-st)); myNetCall.success(call, response); } }); } /** * post请求，异步方式，提交数据，是在子线程中执行的，需要切换到主线程才能更新UI * * @param url * @param bodyParams * @param myNetCall */ public void postDataAsyn(String url, Map<String, String> bodyParams, Map<String, String> headerParams, final MyNetCall myNetCall) { postDataAsyn(url,bodyParams, headerParams, null, myNetCall); } /** * post请求，异步方式，提交数据，是在子线程中执行的，需要切换到主线程才能更新UI * * @param url * @param bodyParams * @param myNetCall */ public void postDataAsyn(String url, Map<String, String> bodyParams, final MyNetCall myNetCall) { postDataAsyn(url,bodyParams, null, myNetCall); } /** * post的请求参数，构造RequestBody * * @param BodyParams * @return */ private RequestBody setRequestBody(Map<String, String> BodyParams) { RequestBody body = null; okhttp3.FormBody.Builder formEncodingBuilder = new okhttp3.FormBody.Builder(); if (BodyParams != null) { Iterator<String> iterator = BodyParams.keySet().iterator(); String key = ""; while (iterator.hasNext()) { key = iterator.next().toString(); formEncodingBuilder.add(key, BodyParams.get(key)); LOG.debug("post http", "post_Params===" + key + "====" + BodyParams.get(key)); } } body = formEncodingBuilder.build(); return body; } /** * 生成安全套接字工厂，用于https请求的证书跳过 * * @return */ public SSLSocketFactory createSSLSocketFactory() { SSLSocketFactory ssfFactory = null; try { SSLContext sc = SSLContext.getInstance("TLS"); sc.init(null, new TrustManager[]{new TrustAllCerts()}, new SecureRandom()); ssfFactory = sc.getSocketFactory(); } catch (Exception e) { } return ssfFactory; } //put json data with header public String putJson(String url, String json, Map<String, String> headerParams) throws IOException { RequestBody body = RequestBody.create(JSON, json); Request.Builder requestBuilder = new Request.Builder(); if (headerParams!=null && headerParams.size() > 0) { requestBuilder.headers(Headers.of(headerParams)); } Request request = requestBuilder .url(url) .put(body) .build(); Response response = mOkHttpClient.newCall(request).execute(); if (response.isSuccessful()) { return response.body().string(); } else { throw new IOException("Unexpected code " + response); } } //post json data with header public String postJson(String url, String json, Map<String, String> headerParams) throws IOException { RequestBody body = RequestBody.create(JSON, json); Request.Builder requestBuilder = new Request.Builder(); if (headerParams!=null && headerParams.size() > 0) { requestBuilder.headers(Headers.of(headerParams)); } Request request = requestBuilder .url(url) .post(body) .build(); Response response = mOkHttpClient.newCall(request).execute(); if (response.isSuccessful()) { return response.body().string(); } else { throw new IOException("Unexpected code " + response); } } //put json data with header public String deleteJson(String url, String json, Map<String, String> headerParams) throws IOException { // RequestBody body = RequestBody.create(JSON, json); Request.Builder requestBuilder = new Request.Builder(); if (headerParams!=null && headerParams.size() > 0) { requestBuilder.headers(Headers.of(headerParams)); } Request request = requestBuilder .url(url) .delete(null) .build(); Response response = mOkHttpClient.newCall(request).execute(); if (response.isSuccessful()) { return response.body().string(); } else { throw new IOException("Unexpected code " + response); } } public String postJson(String url, String json) throws IOException { return postJson(url, json, null); } public void postJsonAsyn(String url, String json, final MyNetCall myNetCall) throws IOException { RequestBody body = RequestBody.create(JSON, json); //2 构造Request Request.Builder requestBuilder = new Request.Builder(); Request request = requestBuilder.post(body).url(url).build(); //3 将Request封装为Call Call call = mOkHttpClient.newCall(request); //4 执行Call call.enqueue(new Callback() { @Override public void onFailure(Call call, IOException e) { myNetCall.failed(call, e); } @Override public void onResponse(Call call, Response response) throws IOException { myNetCall.success(call, response); } }); } /** * 自定义网络回调接口 */ public interface MyNetCall { void success(Call call, Response response) throws IOException; void failed(Call call, IOException e); } /** * 用于信任所有证书 */ class TrustAllCerts implements X509TrustManager { @Override public void checkClientTrusted(X509Certificate[] x509Certificates, String s) throws CertificateException { } @Override public void checkServerTrusted(X509Certificate[] x509Certificates, String s) throws CertificateException { } @Override public X509Certificate[] getAcceptedIssuers() { return new X509Certificate[0]; } } /** 根据Tag取消请求 */ public void cancelTag(String tag) { if (tag == null) return; for (Call call : mOkHttpClient.dispatcher().queuedCalls()) { if (tag.equals(call.request().tag())) { call.cancel(); } } for (Call call : mOkHttpClient.dispatcher().runningCalls()) { if (tag.equals(call.request().tag())) { call.cancel(); } } } } |
上方类中，很多方法用不到，其中主要用到了三个方法：putJson、postJson、deleteJson；其余大部分方法都是冗余方法。
对应的方法编写好了，接下来写调用实例。
3、实例调用代码
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 |
public void putSymmetricServiceRequest(String appName,String routName,String[] routUris) { try { //编写json结构体 JSONObject topJsonObj = new JSONObject(); JSONArray uris = new JSONArray(); for(String routUri:routUris){ String value = "/"+appName+routUri; uris.add(value); } topJsonObj.put("uris",uris); topJsonObj.put("name",routName); JSONArray methods = new JSONArray(); methods.add("GET"); methods.add("POST"); methods.add("PUT"); methods.add("DELETE"); methods.add("PATCH"); methods.add("HEAD"); methods.add("OPTIONS"); methods.add("CONNECT"); methods.add("TRACE"); topJsonObj.put("methods",methods); JSONObject plugins = new JSONObject(); JSONObject jwt_auth = new JSONObject(); jwt_auth.put("disable",false); plugins.put("jwt-auth",jwt_auth); JSONObject proxy_rewrite = new JSONObject(); JSONArray regex_uri = new JSONArray(); regex_uri.add("/"+appName+"/*"); regex_uri.add("/$1"); proxy_rewrite.put("regex_uri",regex_uri); proxy_rewrite.put("scheme","http"); plugins.put("proxy-rewrite",proxy_rewrite); topJsonObj.put("plugins",plugins); //TODO 这里应该填写微服务网关唯一标识，如果为全局微服务网关值为default topJsonObj.put("upstream_id","default"); topJsonObj.put("status",1); //定义headers final HashMap<String, String> headers = new HashMap<String, String>(); //添加登录密码，后面的value值是admin的64base值 headers.put("X-API-KEY", "edd1c9f034335f136f87ad84b625c8f1"); //定义body String body = topJsonObj.toJSONString(); OkHttpUtils okHttpUtils = OkHttpUtils.getInstance(); String url = "http://" + apisixIp + ":9080/apisix/admin/routes/"+appName+"_"+routName; String response = okHttpUtils.putJson(url, body, headers); log.info("putSymmetricServiceRequest: " + response); } catch (IOException e) { e.printStackTrace(); } } |
因为命令中使用的是put，所以这里使用putJson方法，如果是delete，则使用deleteJson方法。
评论