從零開始實現放置遊戲(七)——實現掛機戰鬥(5)RMS系統後臺引數校驗
前面幾章實現了在RMS系統中進行資料的增刪查改以及通過Excel批量匯入。但仍有遺留的問題,比如在新增或編輯時,怪物的生命值、護甲等資料我們可以輸入負值,這種資料是不合理且沒有意義的。本章我們就實現服務端對引數的校驗。
一、新增依賴項
在rms模組的pom.xml中,新增校驗元件的依賴項(注意:之前的元件我們都引用了最新版本。但因hibernate-validator的最新版本6.xx+中引用的el-api.jar有衝突,無法用maven外掛啟動,所以這裡使用5.1.1版本):
<!-- 引數校驗 --> <dependency> <groupId>org.hibernate</groupId> <artifactId>hibernate-validator</artifactId> <version>5.1.1.Final</version> </dependency>
這個元件本身提供了一些註解,@NotNull, @NotBlank, @Min等等,來對模型進行校驗,但錯誤提示不夠好,預設通用的錯誤提示無法明確知道是哪個欄位報錯。如果為每個欄位新增一個提示語,又非常繁瑣,所以我們這裡稍加改動,在util模組做一個通用的校驗工具包。
在util模組的pom.xml中新增依賴:
<dependency> <groupId>javax.validation</groupId> <artifactId>validation-api</artifactId> <version>2.0.1.Final</version> <scope>provided</scope> </dependency>
二、新增自定義註解及提示資訊
以非空校驗為例,在util模組中新建包com.idlewow.util.validation.annotaion,在此包下新建一個註解類NotBlank.java如下:
package com.idlewow.util.validation.annotation; import com.idlewow.util.validation.validator.NotBlankValidator; import javax.validation.Constraint; import javax.validation.Payload; import javax.validation.ReportAsSingleViolation; import java.lang.annotation.Documented; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; @Documented @Target({ElementType.METHOD, ElementType.FIELD, ElementType.ANNOTATION_TYPE, ElementType.CONSTRUCTOR, ElementType.PARAMETER}) @Retention(RetentionPolicy.RUNTIME) @ReportAsSingleViolation @Constraint(validatedBy = NotBlankValidator.class) @NotNull public @interface NotBlank { String field() default ""; String message() default "{field.not.blank.message}"; Class<?>[] groups() default {}; Class<? extends Payload>[] payload() default {}; @Target({ElementType.METHOD, ElementType.FIELD, ElementType.ANNOTATION_TYPE, ElementType.CONSTRUCTOR, ElementType.PARAMETER}) @Retention(RetentionPolicy.RUNTIME) @Documented @interface List { NotBlank[] value(); } }
註解有了,還需要一個對應的檢驗器,新建包com.idlewow.util.validation.validator,並在此包下新建類NotBlankValidator如下:
package com.idlewow.util.validation.validator; import com.idlewow.util.validation.annotation.NotBlank; import javax.validation.ConstraintValidator; import javax.validation.ConstraintValidatorContext; public class NotBlankValidator implements ConstraintValidator<NotBlank, CharSequence> { public NotBlankValidator() { } public void initialize(NotBlank annotation) { } @Override public boolean isValid(CharSequence charSequence, ConstraintValidatorContext constraintValidatorContext) { if (charSequence == null) { return false; } else { return charSequence.toString().trim().length() > 0; } } }
另外,在對模型進行校驗時,不同場景下的需求不同。比如,在新增時,因為主鍵由資料庫自增,無需新增主鍵;編輯時,則必須指定主鍵ID,對其進行非空校驗。因此,我們在com.idlewow.util.validation包下在新建一個對校驗分組的類ValidateGroup:
package com.idlewow.util.validation; import javax.validation.groups.Default; import java.io.Serializable; public class ValidateGroup implements Serializable { public interface Create extends Default { } public interface Update extends Default { } }
最後,我們在util模組的resource資源目錄下新增提示資訊的資原始檔ValidationMessages.properties,
#common invalid message field.not.blank.message={field}不能為空 field.not.null.message={field}不能為NULL field.size.message={field}的長度應為{min}至{max}之間 field.min.message={field}不能小於{value} field.max.message={field}不能大於{value} field.range.message={field}的大小應為{min}至{max}之間 field.positive.message={field}必須是正數 field.negative.message={field}必須是負數
三、引數校驗註解的使用
首先,我們需要在需要校驗的模型上加上註解,此處以怪物模型為例:
package com.idlewow.mob.model; import com.idlewow.common.model.BaseModel; import com.idlewow.util.validation.annotation.NotBlank; import com.idlewow.util.validation.annotation.NotNull; import com.idlewow.util.validation.annotation.Positive; import lombok.Data; import lombok.EqualsAndHashCode; import java.io.Serializable; @Data @EqualsAndHashCode(callSuper = true) public class MapMob extends BaseModel implements Serializable { @NotBlank(field = "主鍵id", groups = ValidateGroup.Update.class) private String id; @NotBlank(field = "怪物名稱") private String name; @NotBlank(field = "地圖id") private String mapId; @NotBlank(field = "地圖名稱") private String mapName; @NotNull(field = "陣營") private Integer faction; @NotNull(field = "怪物種類") private Integer mobClass; @NotNull(field = "怪物型別") private Integer mobType; @Positive(field = "等級") private Integer level; @Positive(field = "生命值") private Integer hp; @Positive(field = "傷害") private Integer damage; @Positive(field = "護甲") private Integer amour; }
模型註解新增完畢,我們在BaseController中新增一個通用的校驗方法,方便在各個Controller中呼叫:
public abstract class BaseController { ...... ...... @Autowired protected Validator validator; ...... ...... protected CommonResult validate(Object object, Class... classes) { Set<ConstraintViolation<Object>> set = validator.validate(object, classes); if (set != null && set.size() > 0) { ConstraintViolation constraintViolation = set.iterator().next(); return CommonResult.fail(constraintViolation.getMessage()); } return CommonResult.success(); } }
在MapMobController的新增和編輯方法中,新增校驗邏輯,
@Controller @RequestMapping("/manage/map_mob") public class MapMobController extends BaseController { …… …… @ResponseBody @RequestMapping(value = "/add", method = RequestMethod.POST) public Object add(@RequestBody MapMob mapMob) { try { CommonResult commonResult = this.validate(mapMob, ValidateGroup.Create.class); if (!commonResult.isSuccess()) return commonResult; mapMob.setCreateUser(this.currentUserName()); mapMobManager.insert(mapMob); return CommonResult.success(); } catch (Exception ex) { logger.error(ex.getMessage(), ex); return CommonResult.fail(); } } …… …… @ResponseBody @RequestMapping(value = "/edit/{id}", method = RequestMethod.POST) public Object edit(@PathVariable String id, @RequestBody MapMob mapMob) { try { if (!id.equals(mapMob.getId())) { return CommonResult.fail("id不一致"); } CommonResult commonResult = this.validate(mapMob, ValidateGroup.Update.class); if (!commonResult.isSuccess()) return commonResult; mapMob.setUpdateUser(this.currentUserName()); mapMobManager.update(mapMob); return CommonResult.success(); } catch (Exception ex) { logger.error(ex.getMessage(), ex); return CommonResult.fail(); } } }
四、執行效果
小結
本章實現了對請求引數的後臺校驗,當然也可以在前端提前進行校驗,但後端的校驗一般必不可少。
原始碼下載地址:https://idlestudio.ctfile.com/fs/14960372-384755438