Замена wordpdf-cli на Spring Boot REST API: wordpdf-app, SPA wordpdf-web, docker-compose
This commit is contained in:
@@ -0,0 +1,94 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<project xmlns="http://maven.apache.org/POM/4.0.0"
|
||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
|
||||
<modelVersion>4.0.0</modelVersion>
|
||||
|
||||
<parent>
|
||||
<groupId>ru.pjandro</groupId>
|
||||
<artifactId>java-word-pdf</artifactId>
|
||||
<version>1.0.0</version>
|
||||
</parent>
|
||||
|
||||
<artifactId>wordpdf-app</artifactId>
|
||||
<name>wordpdf-app</name>
|
||||
<description>REST API поверх wordpdf-core: POST /api/v1/convert (Spring Boot, Swagger UI)</description>
|
||||
|
||||
<dependencies>
|
||||
<dependency>
|
||||
<groupId>ru.pjandro</groupId>
|
||||
<artifactId>wordpdf-core</artifactId>
|
||||
<version>${project.version}</version>
|
||||
<!-- slf4j-simple из ядра исключаем: с logback из Boot получилось бы
|
||||
два SLF4J-провайдера и недетерминированный выбор; предупреждение
|
||||
docx4j в PDF возникает только при полном отсутствии провайдеров,
|
||||
logback его закрывает. -->
|
||||
<exclusions>
|
||||
<exclusion>
|
||||
<groupId>org.slf4j</groupId>
|
||||
<artifactId>slf4j-simple</artifactId>
|
||||
</exclusion>
|
||||
</exclusions>
|
||||
</dependency>
|
||||
<!-- Web MVC (в Boot 4 стартер переименован из spring-boot-starter-web) -->
|
||||
<dependency>
|
||||
<groupId>org.springframework.boot</groupId>
|
||||
<artifactId>spring-boot-starter-webmvc</artifactId>
|
||||
</dependency>
|
||||
<!-- Swagger UI /swagger-ui.html + OpenAPI /v3/api-docs -->
|
||||
<dependency>
|
||||
<groupId>org.springdoc</groupId>
|
||||
<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
|
||||
</dependency>
|
||||
|
||||
<!-- ============ Тесты ============ -->
|
||||
<dependency>
|
||||
<groupId>org.springframework.boot</groupId>
|
||||
<artifactId>spring-boot-starter-test</artifactId>
|
||||
<scope>test</scope>
|
||||
</dependency>
|
||||
<!-- MockMvc-автоконфигурация (@AutoConfigureMockMvc) в Boot 4 вынесена
|
||||
из starter-test в отдельный модуль spring-boot-webmvc-test -->
|
||||
<dependency>
|
||||
<groupId>org.springframework.boot</groupId>
|
||||
<artifactId>spring-boot-webmvc-test</artifactId>
|
||||
<scope>test</scope>
|
||||
</dependency>
|
||||
<!-- Фикстуры samples/*.docx из ядра -->
|
||||
<dependency>
|
||||
<groupId>ru.pjandro</groupId>
|
||||
<artifactId>wordpdf-core</artifactId>
|
||||
<version>${project.version}</version>
|
||||
<classifier>tests</classifier>
|
||||
<type>test-jar</type>
|
||||
<scope>test</scope>
|
||||
</dependency>
|
||||
<!-- Разбор ответного PDF в тестах -->
|
||||
<dependency>
|
||||
<groupId>org.apache.pdfbox</groupId>
|
||||
<artifactId>pdfbox</artifactId>
|
||||
<scope>test</scope>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
|
||||
<build>
|
||||
<plugins>
|
||||
<!-- Исполняемый jar: repackage явно привязан к package (в 4.1.1
|
||||
сам не связывается), main-класс определяется автоматически.
|
||||
Вложенные jar'ы сохраняются раздельно — слияние
|
||||
META-INF/services (как был нужен shade в CLI) здесь не требуется. -->
|
||||
<plugin>
|
||||
<groupId>org.springframework.boot</groupId>
|
||||
<artifactId>spring-boot-maven-plugin</artifactId>
|
||||
<executions>
|
||||
<execution>
|
||||
<id>repackage</id>
|
||||
<goals>
|
||||
<goal>repackage</goal>
|
||||
</goals>
|
||||
</execution>
|
||||
</executions>
|
||||
</plugin>
|
||||
</plugins>
|
||||
</build>
|
||||
</project>
|
||||
@@ -0,0 +1,82 @@
|
||||
package ru.pjandro.wordpdf.app;
|
||||
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
import org.springframework.http.HttpStatus;
|
||||
import org.springframework.http.ResponseEntity;
|
||||
import org.springframework.web.bind.MissingServletRequestParameterException;
|
||||
import org.springframework.web.bind.annotation.ExceptionHandler;
|
||||
import org.springframework.web.bind.annotation.RestControllerAdvice;
|
||||
import org.springframework.web.multipart.MaxUploadSizeExceededException;
|
||||
import org.springframework.web.multipart.support.MissingServletRequestPartException;
|
||||
|
||||
/**
|
||||
* Единый перевод исключений в JSON {@code {"error": "..."}} с кодом по смыслу.
|
||||
*
|
||||
* <p>Голый {@code ru.pjandro.wordpdf.ConversionException} ядра сюда не доходит:
|
||||
* контроллер и {@link ConversionService} превращают его на границе в
|
||||
* {@link ValidationException}/{@link ConversionFailedException}; случайная
|
||||
* утечка попадёт в обработчик {@link Exception} (500).</p>
|
||||
*/
|
||||
@RestControllerAdvice
|
||||
final class ApiExceptionHandler {
|
||||
|
||||
private static final Logger log = LoggerFactory.getLogger(ApiExceptionHandler.class);
|
||||
|
||||
/** Тело ответа ошибки; Jackson сериализует record как есть. */
|
||||
record ApiError(String error) {
|
||||
}
|
||||
|
||||
/** Некорректный вход: пустой, не .docx, не zip, битый zip, > 5 MiB, > 100 страниц. */
|
||||
@ExceptionHandler(ValidationException.class)
|
||||
ResponseEntity<ApiError> validation(ValidationException e) {
|
||||
return ResponseEntity.badRequest().body(new ApiError(e.getMessage()));
|
||||
}
|
||||
|
||||
/** Ошибка ядра/рендера при формально корректном входе. */
|
||||
@ExceptionHandler(ConversionFailedException.class)
|
||||
ResponseEntity<ApiError> conversionFailed(ConversionFailedException e) {
|
||||
return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR)
|
||||
.body(new ApiError(e.getMessage()));
|
||||
}
|
||||
|
||||
/** Очередь конвертации занята/прерывание — повторить позже. */
|
||||
@ExceptionHandler(ConversionRejectedException.class)
|
||||
ResponseEntity<ApiError> rejected(ConversionRejectedException e) {
|
||||
return ResponseEntity.status(HttpStatus.SERVICE_UNAVAILABLE)
|
||||
.body(new ApiError(e.getMessage()));
|
||||
}
|
||||
|
||||
/** Конвертация дольше {@code wordpdf.convert-timeout}. */
|
||||
@ExceptionHandler(ConversionTimeoutException.class)
|
||||
ResponseEntity<ApiError> timeout(ConversionTimeoutException e) {
|
||||
return ResponseEntity.status(HttpStatus.GATEWAY_TIMEOUT)
|
||||
.body(new ApiError(e.getMessage()));
|
||||
}
|
||||
|
||||
/**
|
||||
* Контейнерный лимит multipart (6 МБ в application.properties) сработал
|
||||
* раньше ядра: текст свой, смысл тот же, что у 400 от {@code WordPdfValidator}.
|
||||
*/
|
||||
@ExceptionHandler(MaxUploadSizeExceededException.class)
|
||||
ResponseEntity<ApiError> tooLarge(MaxUploadSizeExceededException e) {
|
||||
return ResponseEntity.status(HttpStatus.PAYLOAD_TOO_LARGE)
|
||||
.body(new ApiError("Файл больше 5 МБ"));
|
||||
}
|
||||
|
||||
/** Партита {@code file} нет в запросе — обе формы исключения возможны. */
|
||||
@ExceptionHandler({MissingServletRequestPartException.class,
|
||||
MissingServletRequestParameterException.class})
|
||||
ResponseEntity<ApiError> missingFile(Exception e) {
|
||||
return ResponseEntity.badRequest()
|
||||
.body(new ApiError("Файл не передан (multipart-поле «file» обязательно)"));
|
||||
}
|
||||
|
||||
/** Прочее — внутренняя ошибка; подробность только в лог, не в ответ. */
|
||||
@ExceptionHandler(Exception.class)
|
||||
ResponseEntity<ApiError> unexpected(Exception e) {
|
||||
log.error("Необработанное исключение в API", e);
|
||||
return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR)
|
||||
.body(new ApiError("Внутренняя ошибка конвертации"));
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,21 @@
|
||||
package ru.pjandro.wordpdf.app;
|
||||
|
||||
/**
|
||||
* Ошибка преобразования: контейнер .docx принят валидацией, но упал сам
|
||||
* рендер (ядро, FOP, повреждённое содержимое внутри валидного zip).
|
||||
*
|
||||
* <p>Смысл отличается от {@link ValidationException}: вход формально корректен,
|
||||
* отказал движок конвертации. Маппится в HTTP 500 ({@link ApiExceptionHandler}).</p>
|
||||
*
|
||||
* <p>Регрессия — ConvertControllerTest#junkInsideValidZip_conversionError.</p>
|
||||
*/
|
||||
class ConversionFailedException extends RuntimeException {
|
||||
|
||||
ConversionFailedException(String message, Throwable cause) {
|
||||
super(message, cause);
|
||||
}
|
||||
|
||||
ConversionFailedException(Throwable cause) {
|
||||
super("Внутренняя ошибка конвертации", cause);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,15 @@
|
||||
package ru.pjandro.wordpdf.app;
|
||||
|
||||
/**
|
||||
* Очередь конвертации переполнена ({@code ConversionService.QUEUE_CAPACITY})
|
||||
* либо поток ожидания был прерван — сервис временно не может принять задачу.
|
||||
*
|
||||
* <p>Маппится в HTTP 503 ({@link ApiExceptionHandler}); клиенту осмысленно
|
||||
* повторить тот же запрос позже.</p>
|
||||
*/
|
||||
class ConversionRejectedException extends RuntimeException {
|
||||
|
||||
ConversionRejectedException() {
|
||||
super("Сервис конвертации занят — повторите позже");
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,204 @@
|
||||
package ru.pjandro.wordpdf.app;
|
||||
|
||||
import jakarta.annotation.PreDestroy;
|
||||
import org.springframework.beans.factory.annotation.Value;
|
||||
import org.springframework.stereotype.Service;
|
||||
import ru.pjandro.wordpdf.ConversionException;
|
||||
import ru.pjandro.wordpdf.WordPdfConverter;
|
||||
import ru.pjandro.wordpdf.WordPdfValidator;
|
||||
|
||||
import java.io.IOException;
|
||||
import java.nio.file.Files;
|
||||
import java.nio.file.Path;
|
||||
import java.time.Duration;
|
||||
import java.util.Locale;
|
||||
import java.util.concurrent.ArrayBlockingQueue;
|
||||
import java.util.concurrent.ExecutionException;
|
||||
import java.util.concurrent.Future;
|
||||
import java.util.concurrent.RejectedExecutionException;
|
||||
import java.util.concurrent.ThreadPoolExecutor;
|
||||
import java.util.concurrent.TimeUnit;
|
||||
import java.util.concurrent.TimeoutException;
|
||||
|
||||
/**
|
||||
* Конвертация .docx-байтов в PDF-байты поверх {@code wordpdf-core}.
|
||||
*
|
||||
* <p>Конвертации СЕРИАЛИЗОВАНЫ однопоточным executor'ом — не «на всякий
|
||||
* случай»: каждая конвертация мутирует ГЛОБАЛЬНЫЙ реестр шрифтов docx4j
|
||||
* ({@code new BundledFontMapper()} заново добавляет системные шрифты
|
||||
* в {@code PhysicalFonts}, {@code BundledFonts.init()/restrictToBundled()}
|
||||
* их вычищают — WordPdfConverter.java:125-130). Параллельные конвертации
|
||||
* вырывают реестр друг у друга из-под рендера, ядро не потокобезопасно
|
||||
* by design. Регрессия — ConvertControllerTest#concurrentRequests_bothSucceed.</p>
|
||||
*
|
||||
* <p>Ошибки разделены по смыслу (требование к API): некорректный вход →
|
||||
* {@link ValidationException} (400), ошибка рендер-стадии →
|
||||
* {@link ConversionFailedException} (500). Граница: сломанный контейнер
|
||||
* (не zip / битый zip / слишком большой / слишком длинный) — 400; валидный
|
||||
* zip с мусором внутри (нет {@code word/document.xml}) — 500: lightweight-
|
||||
* подсчёт страниц согласован с JAXB-путём ядра (может только завышать),
|
||||
* поэтому уже принятый запрос внутренняя проверка ядра в ошибку не превратит.</p>
|
||||
*/
|
||||
@Service
|
||||
final class ConversionService {
|
||||
|
||||
/** Сколько запросов ждут свободный воркер, прежде чем получить 503. */
|
||||
static final int QUEUE_CAPACITY = 16;
|
||||
|
||||
private final ThreadPoolExecutor workers;
|
||||
private final Duration timeout;
|
||||
|
||||
ConversionService(@Value("${wordpdf.convert-timeout:2m}") Duration timeout) {
|
||||
this.timeout = timeout;
|
||||
this.workers = new ThreadPoolExecutor(1, 1, 0L, TimeUnit.MILLISECONDS,
|
||||
new ArrayBlockingQueue<>(QUEUE_CAPACITY));
|
||||
}
|
||||
|
||||
/**
|
||||
* Полный путь: синхронная валидация байтов (до очереди — от obvious-отказа
|
||||
* единый воркер не должен быть занят) → постановка в очередь → ожидание
|
||||
* результата с таймаутом.
|
||||
*
|
||||
* @throws ValidationException некорректный вход (400)
|
||||
* @throws ConversionFailedException ошибка ядра/рендера (500)
|
||||
* @throws ConversionRejectedException очередь полна / прерывание (503)
|
||||
* @throws ConversionTimeoutException конвертация дольше {@code wordpdf.convert-timeout} (504)
|
||||
*/
|
||||
byte[] convert(byte[] docxBytes, String originalFilename) {
|
||||
validate(docxBytes);
|
||||
Future<byte[]> future;
|
||||
try {
|
||||
future = workers.submit(() -> doConvert(docxBytes, originalFilename));
|
||||
} catch (RejectedExecutionException e) {
|
||||
throw new ConversionRejectedException();
|
||||
}
|
||||
try {
|
||||
return future.get(timeout.toMillis(), TimeUnit.MILLISECONDS);
|
||||
} catch (TimeoutException e) {
|
||||
// cancel(true) не гарантирует мгновенной остановки FOP-рендера:
|
||||
// воркер может ещё поработать на отменённой задаче. Принято
|
||||
// осознанно — защита от зависания важнее точности отмены.
|
||||
future.cancel(true);
|
||||
throw new ConversionTimeoutException(timeout);
|
||||
} catch (InterruptedException e) {
|
||||
Thread.currentThread().interrupt();
|
||||
future.cancel(true);
|
||||
throw new ConversionRejectedException();
|
||||
} catch (ExecutionException e) {
|
||||
Throwable cause = e.getCause();
|
||||
if (cause instanceof ValidationException ve) {
|
||||
throw ve;
|
||||
}
|
||||
if (cause instanceof ConversionFailedException cfe) {
|
||||
throw cfe;
|
||||
}
|
||||
if (cause instanceof ConversionRejectedException cre) {
|
||||
throw cre;
|
||||
}
|
||||
if (cause instanceof ConversionTimeoutException cte) {
|
||||
throw cte;
|
||||
}
|
||||
// любой прочий выход из воркера (в т.ч. не завёрнутый
|
||||
// ConversionException ядра) — внутренняя ошибка, 500
|
||||
throw new ConversionFailedException(e);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Валидация байтов переиспользует публичные byte-API ядра. Порядок значим:
|
||||
* размер (дешёвая) → magic bytes → lightweight-разбор zip.
|
||||
*
|
||||
* <p>Проверка zip-подписи отдельным шагом обязательна:
|
||||
* {@code ZipInputStream.getNextEntry()} на не-zip-потоке возвращает
|
||||
* {@code null} молча, и {@link WordPdfValidator#checkPageCountLightweight(byte[])}
|
||||
* такой вход не отверг бы (0 страниц). Регрессия —
|
||||
* ConvertControllerTest#corruptNotAZip_rejected.</p>
|
||||
*/
|
||||
void validate(byte[] docxBytes) {
|
||||
try {
|
||||
WordPdfValidator.checkInput(docxBytes);
|
||||
} catch (ConversionException e) {
|
||||
throw new ValidationException(e.getMessage(), e);
|
||||
}
|
||||
if (docxBytes.length < 4 || docxBytes[0] != 'P' || docxBytes[1] != 'K'
|
||||
|| (docxBytes[2] & 0xFF) != 0x03 || (docxBytes[3] & 0xFF) != 0x04) {
|
||||
throw new ValidationException("Содержимое не похоже на .docx (не zip-архив)");
|
||||
}
|
||||
try {
|
||||
WordPdfValidator.checkPageCountLightweight(docxBytes);
|
||||
} catch (ConversionException e) {
|
||||
throw new ValidationException(e.getMessage(), e);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Тело задачи воркера. Байтового API в ядре нет ({@code convertToStream}
|
||||
* private и принимает {@code Path}), поэтому временные файлы; имя docx
|
||||
* влияет на заголовок PDF (ядро берёт baseName файла), потому санитизировано.
|
||||
*/
|
||||
private static byte[] doConvert(byte[] docxBytes, String originalFilename) {
|
||||
Path dir = null;
|
||||
Path in = null;
|
||||
Path out = null;
|
||||
try {
|
||||
dir = Files.createTempDirectory("wordpdf-");
|
||||
String docxName = safeDocxName(originalFilename);
|
||||
in = dir.resolve(docxName);
|
||||
out = dir.resolve(safeBaseName(originalFilename) + ".pdf");
|
||||
Files.write(in, docxBytes);
|
||||
WordPdfConverter.convert(in, out);
|
||||
return Files.readAllBytes(out);
|
||||
} catch (ConversionException e) {
|
||||
// всё, что упало на рендер-стадии, — ошибка преобразования, 500
|
||||
throw new ConversionFailedException("Не удалось конвертировать документ: "
|
||||
+ e.getMessage(), e);
|
||||
} catch (IOException e) {
|
||||
throw new ConversionFailedException(e);
|
||||
} finally {
|
||||
deleteQuietly(out);
|
||||
deleteQuietly(in);
|
||||
deleteQuietly(dir);
|
||||
}
|
||||
}
|
||||
|
||||
/** Имя docx для временного файла: чистый base + обязательный суффикс .docx. */
|
||||
static String safeDocxName(String original) {
|
||||
return safeBaseName(original) + ".docx";
|
||||
}
|
||||
|
||||
/**
|
||||
* Санитизация имени (единый источник для имени файла и Content-Disposition):
|
||||
* без каталога, только буквы/цифры/пробел/ {@code . _ -}, без суффикса
|
||||
* .docx; пустое после очистки → {@code document}. Кириллица разрешена —
|
||||
* на Linux это валидное имя файла, и заголовок PDF остаётся читаемым.
|
||||
*/
|
||||
static String safeBaseName(String original) {
|
||||
String base = original == null ? ""
|
||||
: original.substring(Math.max(original.lastIndexOf('/'),
|
||||
original.lastIndexOf('\\')) + 1);
|
||||
base = base.replaceAll("[^\\p{L}\\p{N} ._-]", "");
|
||||
if (base.toLowerCase(Locale.ROOT).endsWith(".docx")) {
|
||||
base = base.substring(0, base.length() - ".docx".length());
|
||||
}
|
||||
if (base.isBlank()) {
|
||||
base = "document";
|
||||
}
|
||||
return base.strip();
|
||||
}
|
||||
|
||||
private static void deleteQuietly(Path p) {
|
||||
if (p == null) {
|
||||
return;
|
||||
}
|
||||
try {
|
||||
Files.deleteIfExists(p);
|
||||
} catch (IOException ignored) {
|
||||
// вторичная ошибка очистки не должна затенять основной результат
|
||||
}
|
||||
}
|
||||
|
||||
@PreDestroy
|
||||
void shutdown() {
|
||||
workers.shutdownNow();
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,18 @@
|
||||
package ru.pjandro.wordpdf.app;
|
||||
|
||||
import java.time.Duration;
|
||||
|
||||
/**
|
||||
* Конвертация не завершилась за {@code wordpdf.convert-timeout}.
|
||||
*
|
||||
* <p>Маппится в HTTP 504 ({@link ApiExceptionHandler}). Отмена задачи
|
||||
* не гарантирует мгновенной остановки FOP-рендера — воркер может ещё
|
||||
* недолго поработать на отменённой задаче (осознанный компромисс,
|
||||
* см. {@link ConversionService}).</p>
|
||||
*/
|
||||
class ConversionTimeoutException extends RuntimeException {
|
||||
|
||||
ConversionTimeoutException(Duration timeout) {
|
||||
super("Конвертация превысила " + timeout.toSeconds() + " с — документ слишком сложный");
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,64 @@
|
||||
package ru.pjandro.wordpdf.app;
|
||||
|
||||
import io.swagger.v3.oas.annotations.Operation;
|
||||
import org.springframework.http.ContentDisposition;
|
||||
import org.springframework.http.HttpHeaders;
|
||||
import org.springframework.http.MediaType;
|
||||
import org.springframework.http.ResponseEntity;
|
||||
import org.springframework.web.bind.annotation.PostMapping;
|
||||
import org.springframework.web.bind.annotation.RequestParam;
|
||||
import org.springframework.web.bind.annotation.RestController;
|
||||
import org.springframework.web.multipart.MultipartFile;
|
||||
|
||||
import java.io.IOException;
|
||||
import java.nio.charset.StandardCharsets;
|
||||
import java.util.Locale;
|
||||
|
||||
/**
|
||||
* Единственный эндпоинт API: {@code POST /api/v1/convert} — multipart-поле
|
||||
* {@code file} (.docx) → синхронный ответ байтами PDF.
|
||||
*
|
||||
* <p>Здесь только HTTP-слой: проверка presence/расширения и формирование
|
||||
* {@code Content-Disposition}; проверка содержимого (zip, размер, страницы) —
|
||||
* зона {@link ConversionService#validate}. Ошибки в JSON-ответ переводит
|
||||
* {@link ApiExceptionHandler}.</p>
|
||||
*/
|
||||
@RestController
|
||||
final class ConvertController {
|
||||
|
||||
private final ConversionService conversionService;
|
||||
|
||||
ConvertController(ConversionService conversionService) {
|
||||
this.conversionService = conversionService;
|
||||
}
|
||||
|
||||
@Operation(summary = "Конвертировать .docx в PDF")
|
||||
@PostMapping(
|
||||
path = "/api/v1/convert",
|
||||
consumes = MediaType.MULTIPART_FORM_DATA_VALUE,
|
||||
produces = MediaType.APPLICATION_PDF_VALUE)
|
||||
ResponseEntity<byte[]> convert(@RequestParam("file") MultipartFile file) {
|
||||
if (file == null || file.isEmpty()) {
|
||||
throw new ValidationException("Файл не передан (multipart-поле «file» обязательно)");
|
||||
}
|
||||
String name = file.getOriginalFilename();
|
||||
if (name == null || !name.toLowerCase(Locale.ROOT).endsWith(".docx")) {
|
||||
// та же формулировка, что у WordPdfValidator.checkInput(Path)
|
||||
throw new ValidationException("Поддерживается только .docx (без .doc): " + name);
|
||||
}
|
||||
byte[] docxBytes;
|
||||
try {
|
||||
docxBytes = file.getBytes();
|
||||
} catch (IOException e) {
|
||||
throw new ValidationException("Не удалось прочитать загруженный файл", e);
|
||||
}
|
||||
byte[] pdf = conversionService.convert(docxBytes, name);
|
||||
ContentDisposition disposition = ContentDisposition.attachment()
|
||||
.filename(ConversionService.safeBaseName(name) + ".pdf", StandardCharsets.UTF_8)
|
||||
.build();
|
||||
return ResponseEntity.ok()
|
||||
.contentType(MediaType.APPLICATION_PDF)
|
||||
.header(HttpHeaders.CONTENT_DISPOSITION, disposition.toString())
|
||||
.body(pdf);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,23 @@
|
||||
package ru.pjandro.wordpdf.app;
|
||||
|
||||
/**
|
||||
* Некорректный вход: пустой файл, не .docx, не zip-архив, размер больше
|
||||
* {@code WordPdfValidator.MAX_INPUT_BYTES}, страниц больше ста.
|
||||
*
|
||||
* <p>Отличается от {@link ConversionFailedException} смыслом: запрос
|
||||
* некорректен сам по себе, повтор его же ничего не изменит. Маппится в HTTP 400
|
||||
* ({@link ApiExceptionHandler}).</p>
|
||||
*
|
||||
* <p>Регрессия — ConvertControllerTest#nonDocxFilename_rejected,
|
||||
* #oversizedOverCoreLimit_rejected, #corruptNotAZip_rejected.</p>
|
||||
*/
|
||||
class ValidationException extends RuntimeException {
|
||||
|
||||
ValidationException(String message) {
|
||||
super(message);
|
||||
}
|
||||
|
||||
ValidationException(String message, Throwable cause) {
|
||||
super(message, cause);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,20 @@
|
||||
package ru.pjandro.wordpdf.app;
|
||||
|
||||
import org.springframework.boot.SpringApplication;
|
||||
import org.springframework.boot.autoconfigure.SpringBootApplication;
|
||||
|
||||
/**
|
||||
* Точка входа REST-приложения: HTTP API конвертации .docx → PDF поверх
|
||||
* {@code wordpdf-core}.
|
||||
*
|
||||
* <p>Единственное место в приложении, где класс не «final + только static»:
|
||||
* Spring-компоненты по определению экземпляры (как {@code BundledFontMapper}
|
||||
* в ядре).</p>
|
||||
*/
|
||||
@SpringBootApplication
|
||||
public final class WordPdfApplication {
|
||||
|
||||
public static void main(String[] args) {
|
||||
SpringApplication.run(WordPdfApplication.class, args);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,10 @@
|
||||
spring.application.name=wordpdf-app
|
||||
# 6MB, а не 5MB: авторитетный лимит — ядро (WordPdfValidator.MAX_INPUT_BYTES
|
||||
# = 5 MiB = 5 242 880 Б). С multipart-лимитом «5MB» (5 000 000 Б) файлы
|
||||
# 5.0–5.24 МБ отбивались бы контейнером с неверным текстом ошибки раньше ядра.
|
||||
# file-size-threshold=6MB держит файл в памяти (ядро и так читает всё в RAM).
|
||||
spring.servlet.multipart.max-file-size=6MB
|
||||
spring.servlet.multipart.max-request-size=6MB
|
||||
spring.servlet.multipart.file-size-threshold=6MB
|
||||
# Таймаут одной конвертации (binding Duration в ConversionService)
|
||||
wordpdf.convert-timeout=2m
|
||||
@@ -0,0 +1,224 @@
|
||||
package ru.pjandro.wordpdf.app;
|
||||
|
||||
import org.apache.pdfbox.Loader;
|
||||
import org.apache.pdfbox.pdmodel.PDDocument;
|
||||
import org.apache.pdfbox.text.PDFTextStripper;
|
||||
import org.junit.jupiter.api.Test;
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
import org.springframework.boot.webmvc.test.autoconfigure.AutoConfigureMockMvc;
|
||||
import org.springframework.boot.test.context.SpringBootTest;
|
||||
import org.springframework.http.HttpHeaders;
|
||||
import org.springframework.http.MediaType;
|
||||
import org.springframework.mock.web.MockMultipartFile;
|
||||
import org.springframework.test.web.servlet.MockMvc;
|
||||
import org.springframework.test.web.servlet.MvcResult;
|
||||
|
||||
import java.io.ByteArrayOutputStream;
|
||||
import java.io.IOException;
|
||||
import java.io.InputStream;
|
||||
import java.nio.charset.StandardCharsets;
|
||||
import java.util.concurrent.CountDownLatch;
|
||||
import java.util.concurrent.ExecutorService;
|
||||
import java.util.concurrent.Executors;
|
||||
import java.util.concurrent.Future;
|
||||
import java.util.zip.ZipEntry;
|
||||
import java.util.zip.ZipOutputStream;
|
||||
|
||||
import static org.junit.jupiter.api.Assertions.assertNotNull;
|
||||
import static org.junit.jupiter.api.Assertions.assertTrue;
|
||||
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.multipart;
|
||||
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content;
|
||||
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.header;
|
||||
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath;
|
||||
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
|
||||
|
||||
/**
|
||||
* Сквозные тесты HTTP API (MockMvc): фикстуры — samples/*.docx из test-jar
|
||||
* ядра, PDF разбирается PDFBox, текст нормализуется по пробелам — паттерны
|
||||
* {@code WordPdfConverterTest} (norm/pdfText).
|
||||
*/
|
||||
@SpringBootTest
|
||||
@AutoConfigureMockMvc
|
||||
class ConvertControllerTest {
|
||||
|
||||
private static final MediaType DOCX =
|
||||
MediaType.parseMediaType("application/vnd.openxmlformats-officedocument.wordprocessingml.document");
|
||||
|
||||
@Autowired
|
||||
private MockMvc mockMvc;
|
||||
|
||||
/** Байты фикстуры из classpath (test-jar core: samples/…). */
|
||||
private static byte[] bytes(String resource) throws IOException {
|
||||
try (InputStream in = ConvertControllerTest.class.getResourceAsStream(resource)) {
|
||||
assertNotNull(in, "Нет ресурса: " + resource);
|
||||
return in.readAllBytes();
|
||||
}
|
||||
}
|
||||
|
||||
private static MockMultipartFile docx(String filename, byte[] content) {
|
||||
return new MockMultipartFile("file", filename, DOCX.toString(), content);
|
||||
}
|
||||
|
||||
/** Нормализует пробельные (PDFTextStripper вставляет переносы). */
|
||||
private static String norm(String s) {
|
||||
return s.replaceAll("\\s+", " ");
|
||||
}
|
||||
|
||||
/** Извлекает весь текст из PDF-байтов (PDFBox, PDFTextStripper). */
|
||||
private static String pdfText(byte[] pdf) throws IOException {
|
||||
try (PDDocument doc = Loader.loadPDF(pdf)) {
|
||||
return new PDFTextStripper().getText(doc);
|
||||
}
|
||||
}
|
||||
|
||||
/** Валидный zip с одной мусорной записью (не OPC-пакет). */
|
||||
private static byte[] zipWithGarbage() throws IOException {
|
||||
ByteArrayOutputStream bos = new ByteArrayOutputStream();
|
||||
try (ZipOutputStream zout = new ZipOutputStream(bos)) {
|
||||
zout.putNextEntry(new ZipEntry("garbage.txt"));
|
||||
zout.write("это не документ".getBytes(StandardCharsets.UTF_8));
|
||||
zout.closeEntry();
|
||||
}
|
||||
return bos.toByteArray();
|
||||
}
|
||||
|
||||
@Test
|
||||
void convertSample_returnsPdf() throws Exception {
|
||||
MvcResult result = mockMvc.perform(multipart("/api/v1/convert")
|
||||
.file(docx("ru-plain.docx", bytes("/samples/ru-plain.docx"))))
|
||||
.andExpect(status().isOk())
|
||||
.andExpect(content().contentType(MediaType.APPLICATION_PDF))
|
||||
.andExpect(header().string(HttpHeaders.CONTENT_DISPOSITION,
|
||||
org.hamcrest.Matchers.containsString("filename*=UTF-8''ru-plain.pdf")))
|
||||
.andReturn();
|
||||
byte[] pdf = result.getResponse().getContentAsByteArray();
|
||||
assertTrue(new String(pdf, 0, 4, StandardCharsets.US_ASCII).equals("%PDF"),
|
||||
"тело не начинается с %PDF");
|
||||
String text = norm(pdfText(pdf));
|
||||
assertTrue(text.contains("Привет, мир!"), "нет «Привет, мир!»: " + text);
|
||||
assertTrue(text.contains("абвгдеёжзийклмнопрстуфхцчшщъыьэюя"),
|
||||
"нет алфавита: " + text);
|
||||
}
|
||||
|
||||
@Test
|
||||
void cyrillicAndPathInFilename_sanitizedResponseName() throws Exception {
|
||||
byte[] sample = bytes("/samples/ru-plain.docx");
|
||||
// имя «отчёт.pdf» в RFC 5987-кодировке
|
||||
mockMvc.perform(multipart("/api/v1/convert").file(docx("отчёт.docx", sample)))
|
||||
.andExpect(status().isOk())
|
||||
.andExpect(header().string(HttpHeaders.CONTENT_DISPOSITION,
|
||||
org.hamcrest.Matchers.containsString(
|
||||
"filename*=UTF-8''%D0%BE%D1%82%D1%87%D1%91%D1%82.pdf")));
|
||||
// «a/../../evil.docx»: каталог и «..» обязаны быть вырезаны
|
||||
mockMvc.perform(multipart("/api/v1/convert").file(docx("a/../../evil.docx", sample)))
|
||||
.andExpect(status().isOk())
|
||||
.andExpect(result -> {
|
||||
String cd = result.getResponse().getHeader(HttpHeaders.CONTENT_DISPOSITION);
|
||||
assertNotNull(cd);
|
||||
assertTrue(!cd.contains("/") && !cd.contains(".."),
|
||||
"в Content-Disposition остались путь/«..»: " + cd);
|
||||
assertTrue(cd.contains("evil.pdf"), "имя не сохранено: " + cd);
|
||||
});
|
||||
}
|
||||
|
||||
@Test
|
||||
void nonDocxFilename_rejected() throws Exception {
|
||||
mockMvc.perform(multipart("/api/v1/convert")
|
||||
.file(docx("notes.txt", bytes("/samples/ru-plain.docx"))))
|
||||
.andExpect(status().isBadRequest())
|
||||
.andExpect(jsonPath("$.error",
|
||||
org.hamcrest.Matchers.containsString(".docx")));
|
||||
}
|
||||
|
||||
@Test
|
||||
void missingPart_rejected() throws Exception {
|
||||
mockMvc.perform(multipart("/api/v1/convert"))
|
||||
.andExpect(status().isBadRequest())
|
||||
.andExpect(jsonPath("$.error",
|
||||
org.hamcrest.Matchers.containsString("не передан")));
|
||||
}
|
||||
|
||||
@Test
|
||||
void emptyFile_rejected() throws Exception {
|
||||
mockMvc.perform(multipart("/api/v1/convert")
|
||||
.file(docx("a.docx", new byte[0])))
|
||||
.andExpect(status().isBadRequest());
|
||||
}
|
||||
|
||||
@Test
|
||||
void oversizedOverCoreLimit_rejected() throws Exception {
|
||||
// 5 MiB + 1 байт: проходит контейнерный multipart-лимит (6 MB)
|
||||
// и отсекается валидацией ядра до очереди
|
||||
byte[] big = new byte[5 * 1024 * 1024 + 1];
|
||||
mockMvc.perform(multipart("/api/v1/convert").file(docx("big.docx", big)))
|
||||
.andExpect(status().isBadRequest())
|
||||
.andExpect(jsonPath("$.error",
|
||||
org.hamcrest.Matchers.containsString("больше 5 МБ")));
|
||||
}
|
||||
|
||||
@Test
|
||||
void tooManyPages_rejectedBeforeRender() throws Exception {
|
||||
mockMvc.perform(multipart("/api/v1/convert")
|
||||
.file(docx("too-many-pages.docx", bytes("/samples/too-many-pages.docx"))))
|
||||
.andExpect(status().isBadRequest())
|
||||
.andExpect(jsonPath("$.error",
|
||||
org.hamcrest.Matchers.containsString("100")));
|
||||
}
|
||||
|
||||
@Test
|
||||
void concurrentRequests_bothSucceed() throws Exception {
|
||||
// регрессия сериализации: без single-thread executor всплывает
|
||||
// гонка глобального реестра PhysicalFonts в ядре
|
||||
byte[] sample = bytes("/samples/ru-plain.docx");
|
||||
ExecutorService pool = Executors.newFixedThreadPool(2);
|
||||
CountDownLatch start = new CountDownLatch(1);
|
||||
try {
|
||||
Future<?>[] futures = new Future<?>[2];
|
||||
for (int i = 0; i < 2; i++) {
|
||||
futures[i] = pool.submit(() -> {
|
||||
try {
|
||||
start.await();
|
||||
MvcResult r = mockMvc.perform(multipart("/api/v1/convert")
|
||||
.file(docx("ru-plain.docx", sample)))
|
||||
.andExpect(status().isOk())
|
||||
.andReturn();
|
||||
byte[] pdf = r.getResponse().getContentAsByteArray();
|
||||
assertTrue(new String(pdf, 0, 4, StandardCharsets.US_ASCII).equals("%PDF"),
|
||||
"ответ не PDF");
|
||||
} catch (Exception e) {
|
||||
throw new IllegalStateException(e);
|
||||
}
|
||||
});
|
||||
}
|
||||
start.countDown();
|
||||
for (Future<?> f : futures) {
|
||||
f.get();
|
||||
}
|
||||
} finally {
|
||||
pool.shutdownNow();
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
void corruptNotAZip_rejected() throws Exception {
|
||||
// без zip-подписи ZipInputStream молча даёт 0 записей — отсекает
|
||||
// отдельная проверка magic bytes
|
||||
mockMvc.perform(multipart("/api/v1/convert")
|
||||
.file(docx("broken.docx", "это просто текст, не архив"
|
||||
.getBytes(StandardCharsets.UTF_8))))
|
||||
.andExpect(status().isBadRequest())
|
||||
.andExpect(jsonPath("$.error",
|
||||
org.hamcrest.Matchers.containsString("не zip-архив")));
|
||||
}
|
||||
|
||||
@Test
|
||||
void junkInsideValidZip_conversionError() throws Exception {
|
||||
// контейнер целый (валидный zip), мусор внутри — это ошибка
|
||||
// преобразования (500), а не валидации (400)
|
||||
mockMvc.perform(multipart("/api/v1/convert")
|
||||
.file(docx("bad.docx", zipWithGarbage())))
|
||||
.andExpect(status().isInternalServerError())
|
||||
.andExpect(jsonPath("$.error",
|
||||
org.hamcrest.Matchers.containsString("Не удалось конвертировать")));
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user