Особенности HttpUrlConnection из java.net
сегодня постараюсь рассказать о том, как можно отправить запрос и прочитать ответ от HTTP сервера, используя URLConnection из библиотеки JRE.
- users.list
- chat.postMessage
- conversations.create
- files.upload
- im.open
GET /users.list HTTP/1.1 Content-Type: application/x-www-form-urlencoded token=xoxp-1234567890-098765-4321-a1b2c3d4e5 Я знал про библиотеку Apache HttpComponents, но для иследовательских целей будем использовать средства доступные в стандартной библиотеке Java 8, а именно имплементацию java.net.URLConnection.
Для получений сущности URLConnection нужно использовать объект класса java.net.URL, его конструктор принимает тип String где помимо всего должен быть указан протокол – в нашем случае https.
После получения сущности URL, вызываем метод openConnection() который возвратит нам сущность HttpsUrlConnection.
String url = “https://slack.com/api/users.list”; URLConnection connection = new URL(url).openConnection(); При этом нужно обработать или пробросить MalformedUrlException и IOException.
После этого переменная connection будет хранить ссылку на объект HttpsUrlConnectionImpl. По умолчанию будет формироваться GET-запрос, для того чтобы добавить Header используем метод setRequestProperty(), который принимает key и value. Нам здесь нужно установить Content-Type который имеет значение application/x-www-form-urlencoded. Ну, и мы это делаем!
connection.setRequestProperty(“Content-Type”, “application/x-www-form-urlencoded”); Теперь осталось только отправить запрос записав в тело наш токен и лимит. Для этого нужно установить поле doOutput объекта connection в положение true, используя метод setDoOutput();
connection.setDoOutput(true); Далее самая интересная часть — нужно как-то передать наше тело запроса в OutputStream. Будем использовать OutputStreamWriter:
OutputStreamWriter writer = new OutputStreamWriter(connection.getOutputStream()); Есть один нюанс: после того, как мы вызвали метод getOutputStream() метод запроса меняется на POST, так как GET не предусматривает наличие request body, но благо что slack ни ставит твёрдое ограничение на метод поэтому всё было хорошо. И поэтому GET-запрос должен выглядеть так:
GET /users.list?token=xoxp-1234567890-098765-4321-a1b2c3d4e5&limit=100 HTTP/1.1 Content-Type: application/x-www-form-urlencoded Но я не стал уже переделывать. И вместо этого наш запрос получился таким:
POST /users.list HTTP/1.1 Content-Type: application/x-www-form-urlencoded token=xoxp-1234567890-098765-4321-a1b2c3d4e5 (*некоторые headers ставятся самим HttpsUrlConnection и здесь они отсутствуют)
И так чтоб записать наше тело запроса пользуемся write();.
String reqBody = “token=xoxp-1234567890-098765-4321-a1b2c3d4e5&limit=100”; writer.write(reqBody); writer.close(); После этого наш запрос будет отправлен, и мы можем прочитать полученный ответ. Важно закрывать OutputStream или делать flush(), перед тем как получать InputStream, иначе данные не уйдут из буффера(как альтернатива можно использовать PrintStream — в методе println() по умолчанию вызывается flush()). Для чтение использовал BufferedReader:
StringBuilder respBody = new StringBuilder(); BufferedReader reader = new BufferedReader(connection.getInputStream()); reader.lines().forEach(l -> respBody.append(l + “\r\n”); reader.close(); (*используем lines() чтобы получить Stream на выходе; \r\n – символ CRLF – вставляет переход на новую строку)
И, если мы успешно проходим аутентификацию, переменная respBody должна хранить наш ответ от сервера, что в нашем случае является JSON объектом. После этого, его можно отправлять на следующий этап обработки.
После некоторой оптимизации всё выглядет так:
package main.java.com.bilichenko.learning; import java.io.BufferedReader; import java.io.IOException; import java.io.InputStreamReader; import java.io.OutputStreamWriter; import java.net.HttpURLConnection; import java.net.MalformedURLException; import java.net.URL; import java.nio.charset.Charset; import java.util.Optional; import java.util.stream.Collectors; public class SlackClient < private static final String HOST = "https://api.slack.com"; private static final String GET_USERS_URI = "/api/users.list"; private static final String TOKEN = "xx-ooo-YOUR-TOKEN-HERE"; public static void main(String[] args) throws IOException < SlackClient slackClient = new SlackClient(); System.out.println(slackClient.getRawResponse(HOST + GET_USERS_URI, "application/x-www-form-urlencoded", "token=" + TOKEN).orElse("no response")); >public Optional getRawResponse(String url, String contentType, String requestBody) throws MalformedURLException, IOException < HttpURLConnection connection = (HttpURLConnection) new URL(url).openConnection(); connection.setRequestProperty("Content-Type", contentType); connection.setConnectTimeout(10000); connection.setRequestMethod("POST"); connection.setDoOutput(true); try(OutputStreamWriter writer = new OutputStreamWriter(connection.getOutputStream())) < writer.write(requestBody); >if (connection.getResponseCode() != 200) < System.err.println("connection failed"); return Optional.empty(); >try(BufferedReader reader = new BufferedReader( new InputStreamReader(connection.getInputStream(), Charset.forName("utf-8")))) < return Optional.of(reader.lines().collect(Collectors.joining(System.lineSeparator()))); >> > Blog
The status line consists of the HTTP version (HTTP/1.1 in the example), a status code (200 in the example), and a very short message corresponding to the status code (OK in the example).
Following is a list of HTTP status codes and associated messages that might be returned from the Web Server −
| Code | Message | Description |
|---|---|---|
| 100 | Continue | Only a part of the request has been received by the server, but as long as it has not been rejected, the client should continue with the request |
| 101 | Switching Protocols | The server switches protocol. |
| 200 | OK | The request is OK |
| 201 | Created | The request is complete, and a new resource is created |
| 202 | Accepted | The request is accepted for processing, but the processing is not complete. |
| 203 | Non-authoritative Information | |
| 204 | No Content | |
| 205 | Reset Content | |
| 206 | Partial Content | |
| 300 | Multiple Choices | A link list. The user can select a link and go to that location. Maximum five addresses |
| 301 | Moved Permanently | The requested page has moved to a new url |
| 302 | Found | The requested page has moved temporarily to a new url |
| 303 | See Other | The requested page can be found under a different url |
| 304 | Not Modified | |
| 305 | Use Proxy | |
| 306 | Unused | This code was used in a previous version. It is no longer used, but the code is reserved |
| 307 | Temporary Redirect | The requested page has moved temporarily to a new url. |
| 400 | Bad Request | The server did not understand the request |
| 401 | Unauthorized | The requested page needs a username and a password |
| 402 | Payment Required | You cannot use this code yet |
| 403 | Forbidden | Access is forbidden to the requested page |
| 404 | Not Found | The server cannot find the requested page. |
| 405 | Method Not Allowed | The method specified in the request is not allowed. |
| 406 | Not Acceptable | The server can only generate a response that is not accepted by the client. |
| 407 | Proxy Authentication Required | You must authenticate with a proxy server before this request can be served. |
| 408 | Request Timeout | The request took longer than the server was prepared to wait. |
| 409 | Conflict | The request could not be completed because of a conflict. |
| 410 | Gone | The requested page is no longer available. |
| 411 | Length Required | The “Content-Length” is not defined. The server will not accept the request without it. |
| 412 | Precondition Failed | The precondition given in the request evaluated to false by the server. |
| 413 | Request Entity Too Large | The server will not accept the request, because the request entity is too large. |
| 414 | Request-url Too Long | The server will not accept the request, because the url is too long. Occurs when you convert a “post” request to a “get” request with a long query information. |
| 415 | Unsupported Media Type | The server will not accept the request, because the media type is not supported. |
| 417 | Expectation Failed | |
| 500 | Internal Server Error | The request was not completed. The server met an unexpected condition. |
| 501 | Not Implemented | The request was not completed. The server did not support the functionality required. |
| 502 | Bad Gateway | The request was not completed. The server received an invalid response from the upstream server. |
| 503 | Service Unavailable | The request was not completed. The server is temporarily overloading or down. |
| 504 | Gateway Timeout | The gateway has timed out. |
| 505 | HTTP Version Not Supported | The server does not support the “http protocol” version. |
Methods to Set HTTP Status Code
The following methods can be used to set HTTP Status Code in your servlet program. These methods are available with HttpServletResponse object.
| Sr.No. | Method & Description |
|---|---|
| 1 | public void setStatus ( int statusCode )This method sets an arbitrary status code. The setStatus method takes an int (the status code) as an argument. If your response includes a special status code and a document, be sure to call setStatus before actually returning any of the content with the PrintWriter. |
| 2 | public void sendRedirect(String url)This method generates a 302 response along with a Location header giving the URL of the new document |
| 3 | public void sendError(int code, String message)This method sends a status code (usually 404) along with a short message that is automatically formatted inside an HTML document and sent to the client. |
HTTP Status Code Example
Following is the example which would send a 407 error code to the client browser and browser would show you “Need authentication. ” message.
// Import required java libraries import java.io.*; import javax.servlet.*; import javax.servlet.http.*; import java.util.*; // Extend HttpServlet class public class showError extends HttpServlet < // Method to handle GET method request. public void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException < // Set error code and reason. response.sendError(407, "Need authentication. " ); >// Method to handle POST method request. public void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException < doGet(request, response); >>
Now calling the above servlet would display the following result −
HTTP Status 407 - Need authentication. type Status report messageNeed authentication. descriptionThe client must first authenticate itself with the proxy (Need authentication. ). Apache Tomcat/5.5.29
Обзор REST. Часть 2: коммуникация между клиентом и сервером
Часть 1: что такое REST В этой части мы подробно рассмотрим, каким образом происходит коммуникация между клиентом и сервером. Попутно мы будем раскрывать новые термины и давать к ним пояснения. Чтобы все было (стало) понятно, будем разбирать клиент-серверную коммуникацию на примере некоторого RESTful приложения. Допустим, мы разрабатываем веб приложение, которое способно хранить информацию о клиентах и их заказах. Т.е. наша система способна манипулировать некоторыми сущностями: создавать их, редактировать, удалять, выдавать информацию о них. Этими сущностями будут:
- clients — клиенты;
- orders — заказы клиентов;
- items — товары.
В REST архитектуре клиенты отправляют на сервер запросы для получения или модификации данных, а сервера отправляют клиентам ответы на их запросы.
Запросы
URI и Ресурсы
- clients — клиенты;
- orders — заказы клиентов;
- items — товары.
- /clients — URI всех имеющихся клиентов;
- /clients/23 — URI конкретного клиента, а именно клиента с — URI конкретного клиента, а именно клиента с и это еще не все. Мы можем продолжить URI, добавив к нему заказы:
- /clients/4/orders — URI всех заказов клиента №4;
- /clients/1/orders/12 — URI заказа №12 клиента №1.
- /clients/1/orders/12/items — URI списка всех товаров в заказе №12 сделанного клиентом №1.
HTTP метод
- GET — служит для получения информации о конкретном ресурсе (через ID) либо о коллекции ресурсов;
- POST — служит для создания нового ресурса;
- PUT — служит для изменения ресурса (через ID);
- DELETE — служит для удаления ресурса (через ID).
Заголовки
- text — text/plain, text/css, text/html;
- image — image/png, image/jpeg, image/gif;
- audio — audio/wav, audio/mpeg;
- video — video/mp4, video/ogg;
- application — application/json, application/pdf, application/xml, application/octet-stream.
Тело запроса
Пересылаемое клиентом сообщение на сервер. Есть у запроса тело или нет, зависит от типа HTTP запроса. Например, запросы GET и DELETE как правило не содержат никакого тела запроса. А вот PUT и POST могут содержать: тут все дело в функциональном назначении типа запроса. Ведь для получения данных и удаления по id (который передается в URL) не нужно слать на сервер дополнительные данные. А вот для создания нового ресурса (запрос POST) нужно этот ресурс передать. Также как и для модификации существующего ресурса. В REST для передачи тела запроса чаще всего используют форматы XML или JSON. Наиболее часто встречается JSON формат. Предположим, мы хотим отправить на сервер запрос, а в нем — создать новый ресурс. Если ты не забыл, в качестве примера мы рассматривали приложение, которое управляет заказами клиентов. Допустим, мы хотим создать нового клиента. В нашем случае мы храним следующую информацию о клиентах: Имя Email Номер телефона Тогда телом такого запроса может быть следующий JSON:
Собираем запросы воедино
Итак, мы рассмотрели с тобой из чего может состоять клиентский запрос. Приведем теперь несколько примеров запросов с описанием
GET /clients/23 Accept : application/json, application/xmlОтветы
Коды HTTP ответов
- 201 Created;
- 401 Unauthorized;
- 507 Insufficient Storage.
- 1ХХ — информационные;
- 2ХХ — информируют о случаях успешного принятия и обработки запроса клиента;
- 3ХХ — сообщают клиенту, что для успешного выполнения операции необходимо сделать другой запрос, как правило по другому URI;
- 4ХХ — ошибка клиента. Например, неправильно составленный запрос или же широко известный код 404 Not Found, которая может возникнуть, когда клиент запрашивает несуществующий ресурс;
- 5ХХ — ошибка сервера. Возвращается клиенту в случае неудачного выполнения операции по вине сервера.