Spring Boot 中 crud如何優(yōu)雅的實(shí)現(xiàn)-附代碼

wing324 發(fā)布于2019-08-16 15:29 / 3508人閱讀

摘要：以下內(nèi)容基于如果你使用的也是相同的技術(shù)棧可以繼續(xù)往下閱讀，如果不是可以當(dāng)作參考。編寫的四種方式裸寫最簡單最粗暴也是使用最多的一種方式，在寫的多了之后可以用生成工具生成。

導(dǎo)讀

在目前接觸過的項(xiàng)目中大多數(shù)的項(xiàng)目都會涉及到： crud相關(guān)的操作，哪如何優(yōu)雅的編寫crud操作呢？
帶著這個問題，我們發(fā)現(xiàn)項(xiàng)目中大量的操作多是創(chuàng)建實(shí)體、刪除實(shí)例、修改實(shí)體、查詢單個實(shí)體、分頁查詢多個實(shí)體，我們有沒有好的方式解決呢？
下面我給出crud編寫的四種方式循序漸進(jìn) ，并分析其優(yōu)勢劣勢，希望有一種能適合你，如果你有其他方式可以留言討論，在此權(quán)當(dāng)拋磚引玉。

以下內(nèi)容基于Spring Boot 、Spring MVC、 Spring Data JPA 如果你使用的也是相同的技術(shù)棧可以繼續(xù)往下閱讀，如果不是可以當(dāng)作參考。

crud編寫的四種方式 1 裸寫crud

最簡單最粗暴也是使用最多的一種方式，在寫的多了之后可以用生成工具生成。

import lombok.AllArgsConstructor;
import org.springframework.beans.BeanUtils;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.http.HttpStatus;
import org.springframework.web.bind.annotation.*;

/**
 * @author yangrd
 * @date 2019/3/4
 **/
@AllArgsConstructor

@RestController
@RequestMapping("/api/banner")
public class BannerController {

    private BannerRepository repository;

    @PostMapping
    @ResponseStatus(HttpStatus.CREATED)
    public Banner save(Banner banner) {
        return repository.save(banner);
    }

    @DeleteMapping("/{id}")
    @ResponseStatus(HttpStatus.NO_CONTENT)
    public void delete(@PathVariable Long id) {
        repository.deleteById(id);
    }

    @PutMapping("/{id}")
    public void update(@PathVariable("id") Banner db, @RequestBody Banner banner) {
        BeanUtils.copyProperties(banner, db);
        repository.save(db);
    }

    @GetMapping
    public Page findAll(Pageable pageable) {
        return repository.findAll(pageable);
    }

    @GetMapping("/{id}")
    public Banner finOne(@PathVariable("id") Banner banner) {
        return banner;
    }
}

優(yōu)勢：能控制到代碼的每一行并非所有的增刪改查都需要

劣勢：在業(yè)務(wù)簡單的情況下會編寫大量的類似代碼這個時(shí)候我們可以用泛型與繼承解決引出 AbstractCrudController

2 extend BaseCrudController

使用抽象的能力，通過抽象類對相同的代碼進(jìn)行封裝，減少子類繼續(xù)編寫重復(fù)的代碼。

import com.st.cms.common.spring.jpa.AbstractEntity;
import org.springframework.beans.BeanUtils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.http.HttpStatus;
import org.springframework.web.bind.annotation.*;

import java.util.UUID;

/**
 * @author yangrd
 * @date 2019/3/1
 **/
public abstract class BaseCrudController> {

    @Autowired
    protected D repository;

    @PostMapping
    @ResponseStatus(HttpStatus.CREATED)
    public T save(@RequestBody T t) {
        return repository.save(t);
    }

    @DeleteMapping("/{id}")
    @ResponseStatus(HttpStatus.NO_CONTENT)
    public void delete(@PathVariable("id") String id) {
        repository.deleteById(id);
    }

    @PutMapping("/{id}")
    @ResponseStatus(HttpStatus.NO_CONTENT)
    public void update(@PathVariable("id") T dbData, @RequestBody T t) {
        BeanUtils.copyProperties(t, dbData,"id");
        repository.saveAndFlush(dbData);
    }


    @GetMapping("/{id}")
    public T get(@PathVariable("id") T t) {
        return t;
    }

}

import com.st.cms.common.spring.mvc.BaseCrudController;
import lombok.AllArgsConstructor;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @author yangrd
 * @date 2019/3/4
 **/
@AllArgsConstructor

@RestController
@RequestMapping("/api/banner")
public class BannerController extends BaseCrudController {

}

優(yōu)勢：在簡單的crud操作中通過泛型與繼承減少編寫大量增刪改查的方法

劣勢：在findAll方法中入?yún)?shù)不好控制，通過HttpServletRequest可以解決這個問題但有會引入大量的獲取值的方法因此BaseCrudController中不提供 findAll 方法由用戶編寫

3 spring data rest

引入spring-boot-starter-data-rest，crud操作可以直接http調(diào)用 ，感興趣的可以翻看官方文檔

    
        org.springframework.boot
        spring-boot-starter-data-rest

優(yōu)勢：spring 家的東西可以很好的與spring boot 整合只需引入一個依賴即可

劣勢：和之前業(yè)務(wù)中返回的數(shù)據(jù)格式內(nèi)容不同（此處也是好處更統(tǒng)一規(guī)范，如果一開始前后端約定好數(shù)據(jù)格式就沒有什么太大的問題）

4 ControllerHelper

重點(diǎn)來了哈哈 直接上代碼

import com.alibaba.fastjson.JSON;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.BeanWrapper;
import org.springframework.beans.BeanWrapperImpl;
import org.springframework.beans.BeansException;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.data.domain.Pageable;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.util.Assert;
import org.springframework.web.bind.annotation.*;

import javax.persistence.EntityNotFoundException;
import java.beans.PropertyDescriptor;
import java.lang.reflect.ParameterizedType;
import java.lang.reflect.Type;
import java.util.*;

/**
 * @author yangrd
 * @date 2019/3/22
 **/
@Slf4j

@RestController
@RequestMapping("/api")
public class ControllerHelper implements ApplicationContextAware {

    private MappingManager mappingManager;

    @PostMapping("/{repository}")
    public ResponseEntity create(@PathVariable String repository, @RequestBody String reqJSON) {
        return mappingManager.getJpaRepository(repository).map(repo -> {
            Object object = mappingManager.getEntityObj(repository);
            Object req = JSON.parseObject(reqJSON, object.getClass());
            BeanUtils.copyProperties(req, object);
            return ResponseEntity.status(HttpStatus.CREATED).body(repo.saveAndFlush(object));
        }).
                orElseGet(() -> ResponseEntity.notFound().build());
    }

    @DeleteMapping("/{repository}/{id}")
    public ResponseEntity delete(@PathVariable String repository, @PathVariable Long id) {
        return mappingManager.getJpaRepository(repository).map(repo -> {
            repo.deleteById(id);
            return ResponseEntity.noContent().build();
        }).
                orElseGet(() -> ResponseEntity.notFound().build());
    }

    @PutMapping("/{repository}/{id}")
    public ResponseEntity update(@PathVariable String repository, @PathVariable Long id, @RequestBody String reqJSON) {
        return mappingManager.getJpaRepository(repository).map(repo -> {
            repo.findById(id).ifPresent(db -> {
                Object req = JSON.parseObject(reqJSON, db.getClass());
                BeanUtils.copyProperties(req, db);
                repo.saveAndFlush(db);
            });
            return ResponseEntity.noContent().build();
        }).
                orElseGet(() -> ResponseEntity.notFound().build());
    }

    @GetMapping("/{repository}/{id}")
    public ResponseEntity get(@PathVariable String repository, @PathVariable Long id) {
        return mappingManager.getJpaRepository(repository).map(repo -> ResponseEntity.ok(repo.findById(id))).
                orElseGet(() -> ResponseEntity.notFound().build());
    }

    @GetMapping("/{repository}")
    public ResponseEntity get(@PathVariable String repository, Pageable pageable) {
        return mappingManager.getJpaRepository(repository).map(repo -> ResponseEntity.ok(repo.findAll(pageable))).
                orElseGet(() -> ResponseEntity.notFound().build());
    }

    class MappingManager {
        private Map entity4Repositories = new HashMap<>();
        private Map entity4Class = new HashMap<>();

        MappingManager(ApplicationContext applicationContext) {
            Map repositoryBeans = applicationContext.getBeansOfType(JpaRepository.class);
            repositoryBeans.forEach((repositoryName, repositoryBean) -> {
                Class entityClass = MappingSupport.getEntityClass(repositoryBean);
                String entityClassName = MappingSupport.getEntityName(entityClass);
                entity4Repositories.put(entityClassName, repositoryBean);
                entity4Class.put(entityClassName, entityClass);
            });
        }

        public Optional getJpaRepository(String repository) {
            return Optional.ofNullable(entity4Repositories.get(repository));
        }

        public Object getEntityObj(String repository) {
            return Optional.ofNullable(entity4Class.get(repository)).map(clazz -> {
                try {
                    return clazz.newInstance();
                } catch (InstantiationException | IllegalAccessException e) {
                    e.printStackTrace();
                }
                return null;
            }).orElseThrow(EntityNotFoundException::new);
        }
    }

    static class MappingSupport {
        static Class getEntityClass(JpaRepository jpaRepository) {
            Type[] jpaInterfacesTypes = jpaRepository.getClass().getGenericInterfaces();
            Type[] type = ((ParameterizedType) ((Class) jpaInterfacesTypes[0]).getGenericInterfaces()[0]).getActualTypeArguments();
            return (Class) type[0];
        }

        static String getEntityName(Class clazz) {
            String simpleName = clazz.getSimpleName();
            return simpleName.substring(0, 1).toLowerCase() + simpleName.substring(1);
        }
    }

    /**
     * @author yangrd
     * @date 2018/8/30
     **/
    static class BeanUtils {

        /**
         * 只拷貝不為null的屬性
         *
         * @param source the source bean
         * @param target the target bean
         * @throws BeansException if the copying failed
         */
        public static void copyProperties(Object source, Object target) throws BeansException {
            org.springframework.beans.BeanUtils.copyProperties(source, target, getNullPropertyNames(source));
        }

        private static String[] getNullPropertyNames(Object source) {
            final BeanWrapper src = new BeanWrapperImpl(source);
            PropertyDescriptor[] pds = src.getPropertyDescriptors();

            Set emptyNames = new HashSet<>();
            for (PropertyDescriptor pd : pds) {
                Object srcValue = src.getPropertyValue(pd.getName());
                if (srcValue == null) {
                    emptyNames.add(pd.getName());
                }
            }
            String[] result = new String[emptyNames.size()];

            return emptyNames.toArray(result);
        }
    }


    @Override
    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
        Assert.notNull(applicationContext, "");
        this.mappingManager = new MappingManager(applicationContext);
    }
}

優(yōu)勢：對spring data rest弱勢的補(bǔ)充可以在不改變之前習(xí)慣的數(shù)據(jù)格式的情況下狠方便的前移，最重要的是相比于 Abstract 方法可以被覆蓋如 findAll 如果你使用如 api/user/{id} spring mvc會優(yōu)先匹配它而不是 api/{repository}/{id} ，后期可以根據(jù)自身業(yè)務(wù)需要打成jar包放在私服上面方便其他項(xiàng)目使用

劣勢：也是除了第一種方式之外其余三種都存在的問題如果并不需要常用所有的五種操作如何禁用哈哈解決方法是有的我們下次再說 >_<