Сборка Spring Boot Scaffolding с нуля (2): добавление общих функций

Spring Boot Java

1. Введение

Начните строить сегодняkono Spring BootСтроительные леса будут интегрированы в первую очередьSpring MVCИ настроить его для удовлетворения потребностей ежедневной разработки.Сначала мы делаем некоторую жесткую настройку требований, а затем добавляем детали позже. Если после прочтения этой статьи у вас возникнут вопросы, вы можете оставить сообщение для обсуждения. Много постоянного внимания, общего обучения, общего прогресса.

Гостиница:gitee.com/felord/kono

GitHub: GitHub.com/не найдено403…

2. Единый возвратный корпус

Очень важно единообразно возвращать данные в процессе разработки. Это удобно для унифицированной обработки переднего плана. Обычно оформляется в виде следующей структуры:

{
    "code": 200,
    "data": {
        "name": "felord.cn",
        "age": 18
    },
    "msg": "",
    "identifier": ""
}
  • codeКод бизнес-статуса должен отличаться от кода статуса http по дизайну.
  • dataНоситель данных используется для загрузки данных, возвращаемых во внешний интерфейс для представления.
  • msgИнформация о подсказке, которая используется для информации о подсказке, возвращаемой после вызова внешнего интерфейса, например «добавление успеха» и «удаление ошибки».
  • identifierЗарезервированный бит идентификации используется в качестве идентификатора обработки некоторых услуг.

Согласно вышеуказанным определениям, он объявил единое тело для возврата объектаRestBody<T>И объявите некоторые статические методы для облегчения определения.

package cn.felord.kono.advice;

import lombok.Data;

import java.io.Serializable;

/**
 * @author felord.cn
 * @since 22:32  2019-04-02
 */
@Data
public class RestBody<T> implements Rest<T>, Serializable {

    private static final long serialVersionUID = -7616216747521482608L;
    private int code = 200;
    private T data;
    private String msg = "";
    private String identifier = "";
 

    public static Rest<?> ok() {
        return new RestBody<>();
    }

    public static Rest<?> ok(String msg) {
        Rest<?> restBody = new RestBody<>();
        restBody.setMsg(msg);
        return restBody;
    }

    public static <T> Rest<T> okData(T data) {
        Rest<T> restBody = new RestBody<>();
        restBody.setData(data);
        return restBody;
    }

    public static <T> Rest<T> okData(T data, String msg) {
        Rest<T> restBody = new RestBody<>();
        restBody.setData(data);
        restBody.setMsg(msg);
        return restBody;
    }


    public static <T> Rest<T> build(int code, T data, String msg, String identifier) {
        Rest<T> restBody = new RestBody<>();
        restBody.setCode(code);
        restBody.setData(data);
        restBody.setMsg(msg);
        restBody.setIdentifier(identifier);
        return restBody;
    }

    public static Rest<?> failure(String msg, String identifier) {
        Rest<?> restBody = new RestBody<>();
        restBody.setMsg(msg);
        restBody.setIdentifier(identifier);
        return restBody;
    }

    public static Rest<?> failure(int httpStatus, String msg ) {
        Rest<?> restBody = new RestBody< >();
        restBody.setCode(httpStatus);
        restBody.setMsg(msg);
        restBody.setIdentifier("-9999");
        return restBody;
    }

    public static <T> Rest<T> failureData(T data, String msg, String identifier) {
        Rest<T> restBody = new RestBody<>();
        restBody.setIdentifier(identifier);
        restBody.setData(data);
        restBody.setMsg(msg);
        return restBody;
    }

    @Override
    public String toString() {
        return "{" +
                "code:" + code +
                ", data:" + data +
                ", msg:" + msg +
                ", identifier:" + identifier +
                '}';
    }
}

Однако каждый раз явно объявлять тело возврата не очень элегантно, поэтому мы надеемся реализовать эту функцию неосознанно.Spring FrameworkПросто чтобы обеспечить эту функциональность, мы используем@RestControllerAdviceа такжеResponseBodyAdvice<T>к каждому из предметов@RestControllerТело ответа помеченного управляющего класса подвергается обработке уведомления после аспекта.

/**
 * 统一返回体包装器
 *
 * @author felord.cn
 * @since 14:58
 **/
@RestControllerAdvice
public class RestBodyAdvice implements ResponseBodyAdvice<Object> {

    @Override
    public boolean supports(MethodParameter methodParameter, Class<? extends HttpMessageConverter<?>> aClass) {
        return true;
    }

    @Override
    public Object beforeBodyWrite(Object o, MethodParameter methodParameter, MediaType mediaType, Class<? extends HttpMessageConverter<?>> aClass, ServerHttpRequest serverHttpRequest, ServerHttpResponse serverHttpResponse) {
        // 如果为空 返回一个不带数据的空返回体       
        if (o == null) {
            return RestBody.ok();
        }
        // 如果 RestBody 的 父类 是 返回值的父类型 直接返回 
        // 方便我们可以在接口方法中直接返回RestBody
        if (Rest.class.isAssignableFrom(o.getClass())) {
            return o;
        }
        // 进行统一的返回体封装
        return RestBody.okData(o);
    }
}

Когда мы возвращаемся к интерфейсу класса объекта автоматически упаковывается в единое тело для возвратаRestBody<T>середина.

Так как естьResponseBodyAdvice, EстьRequestBodyAdvice, который, кажется, предназначен для предварительной обработки и может быть использован позже.

2. Единая обработка исключений

Единое исключение также@RestControllerAdviceможет быть достигнуто, пожалуйста, обратитесь к предыдущемуПараметры проверки Hibernate Validator полная стратегия. Здесь изначально интегрирована обработка исключений проверки, а другие исключения будут добавлены позже.

/**
 * 统一异常处理
 *
 * @author felord.cn
 * @since 13 :31  2019-04-11
 */
@Slf4j
@RestControllerAdvice
public class ApiExceptionHandleAdvice {

    @ExceptionHandler(BindException.class)
    public Rest<?> handle(HttpServletRequest request, BindException e) {
        logger(request, e);
        List<ObjectError> allErrors = e.getAllErrors();
        ObjectError objectError = allErrors.get(0);
        return RestBody.failure(700, objectError.getDefaultMessage());
    }

    @ExceptionHandler(MethodArgumentNotValidException.class)
    public Rest<?> handle(HttpServletRequest request, MethodArgumentNotValidException e) {
        logger(request, e);
        List<ObjectError> allErrors = e.getBindingResult().getAllErrors();
        ObjectError objectError = allErrors.get(0);
        return RestBody.failure(700, objectError.getDefaultMessage());
    }

    @ExceptionHandler(ConstraintViolationException.class)
    public Rest<?> handle(HttpServletRequest request, ConstraintViolationException e) {
        logger(request, e);
        Optional<ConstraintViolation<?>> first = e.getConstraintViolations().stream().findFirst();
        String message = first.isPresent() ? first.get().getMessage() : "";
        return RestBody.failure(700, message);
    }


    @ExceptionHandler(Exception.class)
    public Rest<?> handle(HttpServletRequest request, Exception e) {
        logger(request, e);
        return RestBody.failure(700, e.getMessage());
    }


    private void logger(HttpServletRequest request, Exception e) {
        String contentType = request.getHeader("Content-Type");
        log.error("统一异常处理 uri: {} content-type: {} exception: {}", request.getRequestURI(), contentType, e.toString());
    }
}

3. Упрощение преобразования типов

упрощатьJava BeanПреобразование между ними также является необходимой функцией. выбрать здесьmapStruct, типобезопасный и более простой в использовании, чем теBeanUtilГораздо полезнее. Но по моему опыту, не используйтеmapStructКомплексные функции предоставлены только простым отображением. Подробнее, пожалуйста, обратитесь к статьеSpring Boot 2 в действии: интеграция преобразования типов MapStruct.

Интеграция очень проста, потому что она вступает в силу только во время компиляции, поэтому время отсчетаscopeЛучше всего установить наcompile,мы вkono-dependenciesДобавьте его управление зависимостями в:

<dependency>
    <groupId>org.mapstruct</groupId>
    <artifactId>mapstruct</artifactId>
    <version>${mapstruct.version}</version>
    <scope>compile</scope>
</dependency>
<dependency>
    <groupId>org.mapstruct</groupId>
    <artifactId>mapstruct-processor</artifactId>
    <version>${mapstruct.version}</version>
    <scope>compile</scope>
</dependency>

существуетkono-appДве приведенные выше зависимости прямо упоминаются в , но этого недостаточно, иlombokЛегко использовать компиляцию вместеSPIошибка. Нам также необходимо интегрировать соответствующие плагины Maven вkono-appПерейти в жизненный цикл компиляции. Ссылка выглядит следующим образом:

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-compiler-plugin</artifactId>
    <version>3.8.1</version>
    <configuration>
        <source>1.8</source>
        <target>1.8</target>
        <showWarnings>true</showWarnings>
        <annotationProcessorPaths>
            <path>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
                <version>${lombok.version}</version>
            </path>
            <path>
                <groupId>org.mapstruct</groupId>
                <artifactId>mapstruct-processor</artifactId>
                <version>${mapstruct.version}</version>
            </path>
        </annotationProcessorPaths>
    </configuration>
</plugin>

Тогда мы можем легко объединитьJava Beanпревратиться в другойJava Bean. Следующий код будетUserInfoПеревести вUserInfoVOи автоматическиUserInfoVO.addTimeНазначается на текущее время, и этот инструмент также автоматически вводитсяSpring IoC, и все это происходит во время компиляции.

Перед компиляцией:

/**
 * @author felord.cn
 * @since 16:09
 **/
@Mapper(componentModel = "spring", imports = {LocalDateTime.class})
public interface BeanMapping {

    @Mapping(target = "addTime", expression = "java(LocalDateTime.now())")
    UserInfoVO toUserInfoVo(UserInfo userInfo);

}

После компиляции:

package cn.felord.kono.beanmapping;

import cn.felord.kono.entity.UserInfo;
import cn.felord.kono.entity.UserInfoVO;
import java.time.LocalDateTime;
import javax.annotation.Generated;
import org.springframework.stereotype.Component;

@Generated(
    value = "org.mapstruct.ap.MappingProcessor",
    date = "2020-07-30T23:11:24+0800",
    comments = "version: 1.3.0.Final, compiler: javac, environment: Java 1.8.0_252 (AdoptOpenJDK)"
)
@Component
public class BeanMappingImpl implements BeanMapping {

    @Override
    public UserInfoVO toUserInfoVo(UserInfo userInfo) {
        if ( userInfo == null ) {
            return null;
        }

        UserInfoVO userInfoVO = new UserInfoVO();

        userInfoVO.setName( userInfo.getName() );
        userInfoVO.setAge( userInfo.getAge() );

        userInfoVO.setAddTime( LocalDateTime.now() );

        return userInfoVO;
    }
}

фактическиmapStructЭто поможет нам написатьGetterа такжеSetter, но не используйте его более сложные преобразования, которые увеличат стоимость обучения и удобство сопровождения.

4. Модульное тестирование

После интеграции вышеперечисленных функций, сделайте юнит-тест, соответственно все пройдено.

    @Autowired
    MockMvc mockMvc;
    @Autowired
    BeanMapping beanMapping;

    /**
     * 测试全局异常处理.
     *
     * @throws Exception the exception
     * @see UserController#getUserInfo()
     */
    @Test
    void testGlobalExceptionHandler() throws Exception {

        String rtnJsonStr = "{\n" +
                "    \"code\": 700,\n" +
                "    \"data\": null,\n" +
                "    \"msg\": \"test global exception handler\",\n" +
                "    \"identifier\": \"-9999\"\n" +
                "}";

        mockMvc.perform(MockMvcRequestBuilders.get("/user/get"))
                .andExpect(MockMvcResultMatchers.content()
                        .json(rtnJsonStr))
                .andDo(MockMvcResultHandlers.print());
    }

    /**
     * 测试统一返回体.
     *
     * @throws Exception the exception
     * @see UserController#getUserVO()
     */
    @Test
    void testUnifiedReturnStruct() throws Exception {
//        "{\"code\":200,\"data\":{\"name\":\"felord.cn\",\"age\":18,\"addTime\":\"2020-07-30T13:08:53.201\"},\"msg\":\"\",\"identifier\":\"\"}";
        mockMvc.perform(MockMvcRequestBuilders.get("/user/vo"))
                .andExpect(MockMvcResultMatchers.jsonPath("code", Is.is(200)))
                .andExpect(MockMvcResultMatchers.jsonPath("data.name", Is.is("felord.cn")))
                .andExpect(MockMvcResultMatchers.jsonPath("data.age", Is.is(18)))
                .andExpect(MockMvcResultMatchers.jsonPath("data.addTime", Is.is(notNullValue())))
                .andDo(MockMvcResultHandlers.print());
    }


    /**
     * 测试 mapStruct类型转换.
     *
     * @see BeanMapping
     */
    @Test
    void testMapStruct() {
        UserInfo userInfo = new UserInfo();
        userInfo.setName("felord.cn");
        userInfo.setAge(18);
        UserInfoVO userInfoVO = beanMapping.toUserInfoVo(userInfo);

        Assertions.assertEquals(userInfoVO.getName(), userInfo.getName());
        Assertions.assertNotNull(userInfoVO.getAddTime());
    }

5. Резюме

Предварительные самодельные строительные лесаединый возврат,Унифицированная обработка исключений,быстрое преобразование типа,фактическипроверка параметровЭто также поддерживается. Настало время интегрировать базу данных в будущем. Обычно используемые технологии доступа к базе данных в основномMybatis,Spring Data JPA,JOOQПодождите, какой из них вы предпочитаете? Добро пожаловать, чтобы оставить сообщение для обсуждения.

关注公众号：Felordcn获取更多资讯

Личный блог: https://felord.cn

Категории