Веб-службы RESTful - первое приложение
Давайте начнем писать настоящие веб-сервисы RESTful с Jersey Framework. Прежде чем вы начнете писать свой первый пример с использованием Jersey Framework, вы должны убедиться, что вы правильно настроили среду Jersey, как описано в главе RESTful Web Services - Environment Setup . Здесь я также предполагаю, что у вас есть некоторые практические знания Eclipse IDE.
Итак, давайте приступим к написанию простого приложения Jersey Application, которое будет предоставлять метод веб-службы для отображения списка пользователей.
Создание проекта Java
Первым шагом является создание динамического веб-проекта с использованием Eclipse IDE. Следуйте вариантуFile → New → Project и, наконец, выберите Dynamic Web Projectмастер из списка мастеров. Теперь назовите свой проект какUserManagement используя окно мастера, как показано на следующем снимке экрана -
Как только ваш проект будет успешно создан, у вас будет следующий контент в вашем Project Explorer -
Добавление необходимых библиотек
В качестве второго шага добавим Jersey Framework и его зависимости (библиотеки) в наш проект. Скопируйте все jar-файлы из следующих каталогов zip-папки download jersey в каталог WEB-INF / lib проекта.
- \jaxrs-ri-2.17\jaxrs-ri\api
- \jaxrs-ri-2.17\jaxrs-ri\ext
- \jaxrs-ri-2.17\jaxrs-ri\lib
Теперь щелкните правой кнопкой мыши имя вашего проекта UserManagement а затем следуйте опции, доступной в контекстном меню - Build Path → Configure Build Path для отображения окна Путь сборки Java.
Теперь используйте Add JARs кнопка доступна под Libraries вкладка, чтобы добавить JAR, присутствующие в каталоге WEBINF / lib.
Создание исходных файлов
Теперь давайте создадим фактические исходные файлы под UserManagementпроект. Сначала нам нужно создать пакет под названиемcom.tutorialspoint. Для этого щелкните правой кнопкой мыши src в разделе проводника пакетов и выберите вариант -New → Package.
Далее мы создадим UserService.java, User.java,UserDao.java файлы в пакете com.tutorialspoint.
User.java
package com.tutorialspoint;
import java.io.Serializable;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
@XmlRootElement(name = "user")
public class User implements Serializable {
private static final long serialVersionUID = 1L;
private int id;
private String name;
private String profession;
public User(){}
public User(int id, String name, String profession){
this.id = id;
this.name = name;
this.profession = profession;
}
public int getId() {
return id;
}
@XmlElement
public void setId(int id) {
this.id = id;
}
public String getName() {
return name;
}
@XmlElement
public void setName(String name) {
this.name = name;
}
public String getProfession() {
return profession;
}
@XmlElement
public void setProfession(String profession) {
this.profession = profession;
}
}UserDao.java
package com.tutorialspoint;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
import java.util.ArrayList;
import java.util.List;
public class UserDao {
public List<User> getAllUsers(){
List<User> userList = null;
try {
File file = new File("Users.dat");
if (!file.exists()) {
User user = new User(1, "Mahesh", "Teacher");
userList = new ArrayList<User>();
userList.add(user);
saveUserList(userList);
}
else{
FileInputStream fis = new FileInputStream(file);
ObjectInputStream ois = new ObjectInputStream(fis);
userList = (List<User>) ois.readObject();
ois.close();
}
} catch (IOException e) {
e.printStackTrace();
} catch (ClassNotFoundException e) {
e.printStackTrace();
}
return userList;
}
private void saveUserList(List<User> userList){
try {
File file = new File("Users.dat");
FileOutputStream fos;
fos = new FileOutputStream(file);
ObjectOutputStream oos = new ObjectOutputStream(fos);
oos.writeObject(userList);
oos.close();
} catch (FileNotFoundException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
}
}UserService.java
package com.tutorialspoint;
import java.util.List;
import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.core.MediaType;
@Path("/UserService")
public class UserService {
UserDao userDao = new UserDao();
@GET
@Path("/users")
@Produces(MediaType.APPLICATION_XML)
public List<User> getUsers(){
return userDao.getAllUsers();
}
}В отношении основной программы следует отметить два важных момента:
UserService.java
Первый шаг - указать путь к веб-службе с помощью аннотации @Path к UserService.
Второй шаг - указать путь для конкретного метода веб-службы с помощью аннотации @Path к методу UserService.
Создание файла конфигурации Web.xml
Вам необходимо создать файл конфигурации Web xml, который является файлом XML и используется для указания сервлета инфраструктуры Джерси для нашего приложения.
web.xml
<?xml version = "1.0" encoding = "UTF-8"?>
<web-app xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance"
xmlns = "http://java.sun.com/xml/ns/javaee"
xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"
id = "WebApp_ID" version = "3.0">
<display-name>User Management</display-name>
<servlet>
<servlet-name>Jersey RESTful Application</servlet-name>
<servlet-class>org.glassfish.jersey.servlet.ServletContainer</servlet-class>
<init-param>
<param-name>jersey.config.server.provider.packages</param-name>
<param-value>com.tutorialspoint</param-value>
</init-param>
</servlet>
<servlet-mapping>
<servlet-name>Jersey RESTful Application</servlet-name>
<url-pattern>/rest/*</url-pattern>
</servlet-mapping>
</web-app>Развертывание программы
После того, как вы закончите создание исходных файлов и файлов веб-конфигурации, вы готовы к этому шагу - компиляции и запуску вашей программы. Для этого с помощью Eclipse экспортируйте свое приложение как файл войны и разверните его в tomcat.
Чтобы создать файл WAR с помощью eclipse, следуйте опции File → export → Web → War Fileи, наконец, выберите проект UserManagement и папку назначения. Чтобы развернуть файл войны в Tomcat, поместите UserManagement.war в папкуTomcat Installation Directory → webapps directory и запустите Tomcat.
Запуск программы
Мы используем Postman , расширение Chrome, для тестирования наших веб-сервисов.
Сделайте запрос в UserManagement, чтобы получить список всех пользователей. Поместите http: // localhost: 8080 / UserManagement / rest / UserService / users в POSTMAN с запросом GET и увидите следующий результат.
Поздравляем, вы успешно создали свое первое приложение RESTful.