- JAX-RS:JavaAPI for RESTful Web Services,JAX-RS是可以用可以用于实现RESTFul应用程序的JAVA API,给开发者提供了一系列的RESTFul注解
- EasyRest:这是Jboss开源的,一款用来定义实现RESTFul应用程序的框架,是基于JAX-RS规范,是JAX-RS API的实现
JAX-RX常用的注解:
@javax.ws.rs.Path // 请求的资源类或资源方法的uri路径
@javax.ws.rs.GET //表示此方法响应HTTP GET请求。
@javax.ws.rs.POST // 表示此方法响应HTTP POST请求。
@javax.ws.rs.PUT // 通常用来更新数据,PUT操作
@javax.ws.rs.DELETE // 通常用来删除数据。
@javax.ws.rs.Produces //设置Http返回报文,报文体的内容类型
@javax.ws.rs.Consumes //客户端请求的MIME媒体类型
@javax.ws.rs.QueryParam // 一般是GET请求的参数,相当于SpringMVC框架的@RequestParam
@javax.ws.rs.FormParam // 媒体类型为”application/x-www-form-urlencoded” 的参数
@javax.ws.rs.PathParam // uri中指定的路径参数绑定到资源方法参数
了解了Jboss的Easyrest后,我们通过一个文件上传的例子来搭建一个RESTFul项目,基于SpringBoot2.0,采用了开源的starter组件resteasy-spring-boot
,GitHub链接:https://github.com/resteasy/resteasy-spring-boot
开发环境
- SpringBoot2.2.1.RELEASE
- resteasy-spring-boot-starter3.3.2.Final
- JDK1.8
- Maven 3.2+
- resteasy-multipart-provider3…9.1.Final
搭建一个SpringBoot项目
在IDEA里new一个project,这里使用Spring Initializer
快速创建一个SpringBoot项目,Server url可以使用Spring官网的,也可以使用阿里的,然后点击Next
选择jdk版本和maven
因为有些jar在start.spring.io
里没集成,所以需要自己加上,可以参考我的配置,注意,这个resteasy-spring-boot-starter
版本尽量高点,因为要和SpringBoot2.0版本兼容,使用降低版本可能会出现如下问题java.lang.IllegalArgumentException: Could not find class [org.springframework.boot.autoconfigure.web.WebMvcAutoConfiguration]
4.0.0
com.example
springboot-jboss-uploadfile
0.0.1-SNAPSHOT
springboot-jboss-uploadfile
jar
Demo project for Spring Boot
UTF-8
1.8
2.2.1.RELEASE
org.springframework.boot
spring-boot-starter-parent
${springboot.version}
pom
import
org.springframework.boot
spring-boot-starter
org.springframework.boot
spring-boot-starter-actuator
runtime
org.springframework.boot
spring-boot-starter-web
javax.ws.rs
javax.ws.rs-api
2.1
org.jboss.resteasy
resteasy-spring-boot-starter
runtime
3.3.2.Final
服务器托管网
org.jboss.resteasy
resteasy-multipart-provider
3.9.1.Final
org.projectlombok
lombok
true
cn.hutool
hutool-all
5.7.11
org.springframework.boot
spring-boot-starter-test
test
org.springframework.boot
spring-boot-maven-plugin
org.projectlombok
lombok
jboss-releases-repository
JBoss Releases Repository
https://repository.jboss.org/nexus/service/local/staging/deploy/maven2/
定义一个JAX-RS的Application类,使用@ApplicationPath
定义根路径,一定要加@Component
才能被Spring容器扫描到
package com.example.jbossuploadfile.configuration;
import org.springframework.stereotype.Component;
import javax.ws.rs.ApplicationPath;
import javax.ws.rs.core.Application;
@Component
@ApplicationPath("/rest/")
public class JAXRSApplication extends Application {
}
application.yml配置文件,定义JAXRSApplication
类的路径
server:
port: 8080
spring:
main:
banner-mode: "off"
resteasy:
jaxrs:
app:
registration: property
classes: com.example.jbossuploadfile.configuration.JAXRSApplication
management:
endpoints:
web:
exposure:
include:
- health
- shutdown
endpoint:
shutdown:
enabled: true
logging:
level:
org:
springframework: info
文件上传例子
然后可以写一个文件上传的例子,定义一个返回的实体类
package com.example.jbossuploadfile.entity;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;
import java.io.Serializable;
@Data
@Builder
@AllArgsConstructor
@NoArgsConstructor
public class FileUploadResult implements Serializable {
private String fileUrl;
private Long fileSize;
private String fileName;
private String fileType;
}
使用MultipartFormDataInput
来实现文件上传,注意客户端传入的媒体格式,要定义为MediaType.MULTIPART_FORM_DATA
,也就是form-data
,才能支持文件上传
package com.example.jbossuploadfile.endpoint;
import cn.hutool.core.io.FileUtil;
import com.example.jbossuploadfile.entity.FileUploadResult;
import lombok.extern.slf4j.Slf4j;
import org.jboss.resteasy.plugins.providers.multipart.InputPart;
import org.jboss.resteasy.plugins.providers.multipart.MultipartFormDataInput;
import org.springframework.stereotype.Component;
import javax.ws.rs.Consumes;
import javax.ws.rs.POST;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.MultivaluedMap;
import java.io.ByteArrayInputStream;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.util.List;
import java.util.Map;
@Slf4j
@Path("/api")
@Component
public class FileUploadEndpoint {
@Path("/v1/fileUpload")
@POST
@Produces({MediaType.APPLICATION_JSON})
@Consumes({MediaType.MULTIPART_FORM_DATA})
public FileUploadResult filepload(MultipartFormDataInput formDataInput) throws IOException {
String fileName = getFileName(formDataInput , "file");
String fileType = fileName.substring(fileName.lastIndexOf("."));
InputStream inputStream = getInputStream(formDataInput , "file");
File file = FileUtil.writeFromStream(inputStream, new File("D:/server/" + fileName));
long length = file.length();
log.info("fileName : [{}] , fileTye : [{}], size:[{}]" , fileName , fileType , length);
return FileUploadResult.builder()
.fileName(fileName)
.fileUrl(file.getPath())
.fileSize(length)
.fileType(fileType).build();
}
private InputStream getInputStream(MultipartFormDataInput input, String s) {
try {
InputStream result;
if (input.getParts().size() == 1) {
InputPart filePart = input.getParts().iterator().next();
result = filePart.getBody(InputStream.class, null);
} else {
result = input.getFormDataPart(s, ByteArrayInputStream.class, null);
}
if (result == null) {
throw new IllegalArgumentException("Can't find a valid 'file' part in the multipart request");
}
return result;
} catch (IOException e) {
throw new IllegalArgumentException("Error while reading multipart request", e);
}
}
private String getFileName(MultipartFormDataInput input , String s) {
Map> uploadForm = input.getFormDataMap();
List inputParts = uploadForm.get(s);
for (InputPart inputPart : inputParts) {
MultivaluedMap header = inputPart.getHeaders();
String[] contentDisposition = header.getFirst("Content-Disposition").split(";");
for (String filename : contentDisposition) {
if ((filename.trim().startsWith("filename"))) {
String[] name = filename.split("=");
String fin服务器托管网alFileName = name[1].trim().replaceAll(""", "");
return finalFileName;
}
}
}
return "unknown";
}
}
在Postman里测试一下,注意使用form-data
方式
服务器托管,北京服务器托管,服务器租用 http://www.fwqtg.net
机房租用,北京机房租用,IDC机房托管, http://www.fwqtg.net
相关推荐: spring boot框架JAVA语言实现的货运系统(司机APP端+货主APP端)
技术架构:spring boot、mybatis、redis、vue、element-ui 开发语言:java、vue、uniapp 开发工具:idea、vscode、hbuilder+ 前端框架:vue 后端框架:spring boo…