构建SpringMVCRestful前后端分离项目实例

log4j.rootLogger=INFO,me.newsong.utils.LoggingAspect
log4j.appender.me.newsong.utils.LoggingAspect=org.apache.log4j.DailyRollingFileAppender
log4j.appender.me.newsong.utils.LoggingAspect.File=${catalina.home}/logs/SpringDataRedis.log
log4j.appender.me.newsong.utils.LoggingAspect.DatePattern='.'yyyy-MM-dd
log4j.appender.me.newsong.utils.LoggingAspect.layout=org.apache.log4j.PatternLayout
log4j.appender.me.newsong.utils.LoggingAspect.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} [%p] %m [%t]%n

2、实体类介绍

@RedisHash("employees")
public class Employee implements Serializable {
/**
*
*/
private static final long serialVersionUID = 6835815975637187630L;

private Integer id;
@NotEmpty
@Indexed
private String lastName;
@Email
private String email;
private String gender;
private Department dept;
private Date birthday;
private double salary;

public Employee() {
}

public Employee(Integer id,String lastName, String email, String gender, Department dept, Date birthday, double salary) {
this.id = id;
this.lastName = lastName;
this.email = email;
this.gender = gender;
this.dept = dept;
this.birthday = birthday;
this.salary = salary;
}

@Id
public Integer getId() {
return id;
}

public void setId(Integer id) {
this.id = id;
}

public String getLastName() {
return lastName;
}

public void setLastName(String lastName) {
this.lastName = lastName;
}

public String getEmail() {
return email;
}

public void setEmail(String email) {
this.email = email;
}

public String getGender() {
return gender;
}

public void setGender(String gender) {
this.gender = gender;
}

public Department getDept() {
return dept;
}

public void setDept(Department dept) {
this.dept = dept;
}

public Date getBirthday() {
return birthday;
}

public void setBirthday(Date birthday) {
this.birthday = birthday;
}

public double getSalary() {
return salary;
}

public void setSalary(double salary) {
this.salary = salary;
}

@Override
public String toString() {
return "Employee [id=" + id + ", lastName=" + lastName + ", email=" + email + ", gender=" + gender + ", dept="
+ dept + ", birthday=" + birthday + ", salary=" + salary + "]";
}

}

3、数据层介绍

@Configuration
@EnableRedisRepositories("me.newsong")
public class RedisConfig {
}

List<Employee> findByLastName(String lastName)

public interface EmployeeRepository extends CrudRepository<Employee, Integer>{
Page<Employee> findAll(Pageable pageable);
List<Employee> findByLastName(String lastName);
}

4、逻辑层介绍

@Transactional
@Service
public class EmployeeServiceImpl implements EmployeeService {
@Autowired
private EmployeeRepository dao;

@Override
public Employee findByID(Integer id) {
return dao.findOne(id);
}

@Override
public void update(Employee employee) {
dao.save(employee);
}

@Override
public void delete(Integer id) {
dao.delete(id);
}

@Override
public void save(Employee employee) {
dao.save(employee);
}

@Override
public Page<Employee> findAll(int pageNum, int pageSize) {
return dao.findAll(new PageRequest(pageNum, pageSize));
}

@Override
public boolean isLastNameValid(String lastName) {
if(dao.findByLastName(lastName).size() == 0){
return true;
}
return false;
}

}

@CrossOrigin
@RestController
public class EmployeeRestController {
@Autowired
private EmployeeService employeeService;

// 显示所有员工信息
@RequestMapping(value = "/emps", method = RequestMethod.GET)
public Page<Employee> findEmployeesByPage(
@RequestParam(value = "pageNum", required = false, defaultValue = "0") String pageNum) {
int page = 0;
try {
page = Integer.parseInt(pageNum);
} catch (NumberFormatException e) {
}
if (page < 0) {
page = 0;
}
return employeeService.findAll(page, 5);
}

// 添加
@RequestMapping(value = "/emp", method = RequestMethod.POST)
public void add(@RequestBody @Valid Employee employee, BindingResult result, Locale locale) {
System.out.println(employee);
if (!validateLastName(employee.getLastName())) {
throw new UsernameExistedException(employee.getLastName(), locale);
} else if (result.hasErrors()) {
throw new ValidationException(result.getFieldErrors());
}
System.out.println("add:" + employee);
employeeService.save(employee);
}

// 删除
@RequestMapping(value = "/emp/{id}", method = RequestMethod.DELETE)
public void delete(@PathVariable("id") Integer id, Locale locale) {
if (employeeService.findByID(id) == null) {
throw new EmployeeNotFoundException(locale);
}
System.out.println("delete:" + id);
employeeService.delete(id);
}

// 更新
@RequestMapping(value = "/emp", method = RequestMethod.PUT)
public void update(@RequestBody @Valid Employee employee, BindingResult result, Locale locale) {
if (result.hasErrors()) {
throw new ValidationException(result.getFieldErrors());
}
System.out.println("update:" + employee);
employeeService.update(employee);
}

// 验证用户名是否合法
@RequestMapping(value = "/emp/{lastName}", method = RequestMethod.GET)
public boolean validateLastName(@PathVariable("lastName") String lastName) {
if (employeeService.isLastNameValid(lastName)) {
System.out.println("用户名可用");
return true;
} else {
System.out.println("用户名不可用");
return false;
}
}
}

6、工具类介绍

@Aspect
@Component
public class LoggingAspect {
private static final Logger logger = Logger.getLogger(LoggingAspect.class.getName());

@Pointcut("execution(* me.newsong.service.impl.*.*(..))||execution(* me.newsong.web.*.*(..))")
public void declareJoinPointExpression() {
}

@Before("declareJoinPointExpression()")
public void beforeMethod(JoinPoint joinPoint) {// 连接点
Object[] args = joinPoint.getArgs();// 取得方法参数
logger.info("The method [" + joinPoint.getSignature() + " ] begins with Parameters: " + Arrays.toString(args));
}

@AfterReturning(value = "declareJoinPointExpression()", returning = "result")
public void afterMethodReturn(JoinPoint joinPoint, Object result) {
logger.info("The method [" + joinPoint.getSignature() + "] ends with Result: " + result);
}

@AfterThrowing(value = "declareJoinPointExpression()", throwing = "e")
public void doAfterThrowing(JoinPoint joinPoint, Exception e) {
logger.error("Error happened in method: [" + joinPoint.getSignature()+"]");
logger.error("Parameters: "+Arrays.toString(joinPoint.getArgs()));
logger.error("Exception StackTrace: ",e);
}
}

@Component
public class InternationalizeUtil {
@Autowired
private ResourceBundleMessageSource ms;
private static InternationalizeUtil util;

@PostConstruct
public void init() {
util = this;
util.ms = this.ms;
}

public static String getMessage(String message,Locale locale){
return util.ms.getMessage(message, null, locale);
}
}

七、异常处理

@ControllerAdvice
public class RestExceptionHandler {

@ExceptionHandler(BaseRestException.class)
public ResponseEntity<RestError> handle(BaseRestException e) {
return new ResponseEntity<RestError>(new RestError(e.getStatus(), e.getCode(), e.getErrors(), ""), e.getStatus());
}
}

public class RestError {
private HttpStatus status;
private int code;
private List<RestFieldError> fieldErrors;
private String moreinfoURL;

public RestError() {
}

public RestError(HttpStatus status, int code, List<RestFieldError> fieldErrors, String moreinfoURL
) {
this.status = status;
this.code = code;
this.fieldErrors = fieldErrors;
this.moreinfoURL = moreinfoURL;
}

public HttpStatus getStatus() {
return status;
}

public void setStatus(HttpStatus status) {
this.status = status;
}

public int getCode() {
return code;
}

public void setCode(int code) {
this.code = code;
}

public List<RestFieldError> getFieldErrors() {
return fieldErrors;
}

public void setFieldErrors(List<RestFieldError> fieldErrors) {
this.fieldErrors = fieldErrors;
}

public String getMoreinfoURL() {
return moreinfoURL;
}

public void setMoreinfoURL(String moreinfoURL) {
this.moreinfoURL = moreinfoURL;
}

@Override
public String toString() {
return "RestError [status=" + status + ", code=" + code + ", fieldErrors=" + fieldErrors + ", moreinfoURL="
+ moreinfoURL + "]";
}
}

public class RestFieldError {
private String field;
private Object rejectedValue;
private String message;

public RestFieldError(FieldError error) {
this.field = error.getField();
this.rejectedValue = error.getRejectedValue();
this.message = error.getDefaultMessage();
}

public RestFieldError(String field, Object rejectedValue, String message) {
super();
this.field = field;
this.rejectedValue = rejectedValue;
this.message = message;
}

public String getField() {
return field;
}

public void setField(String field) {
this.field = field;
}

public Object getRejectedValue() {
return rejectedValue;
}

public void setRejectedValue(Object rejectedValue) {
this.rejectedValue = rejectedValue;
}

public String getMessage() {
return message;
}

public void setMessage(String message) {
this.message = message;
}

@Override
public String toString() {
return "RestFieldError [field=" + field + ", rejectedValue=" + rejectedValue + ", message=" + message + "]";
}
}

public class BaseRestException extends RuntimeException {
/**
*
*/
private static final long serialVersionUID = 1330458449080010936L;
private HttpStatus status;
private int code;
private List<RestFieldError> error;

public BaseRestException() {
}

public BaseRestException(HttpStatus status, int code, Locale locale, String field, Object rejectedValue) {
this.status = status;
this.code = code;
this.error = Arrays.asList(new RestFieldError(field, rejectedValue,
InternationalizeUtil.getMessage("i18n." + this.getMessageKey(), locale)));
}

public BaseRestException(HttpStatus status, int code, List<RestFieldError> error) {
this.status = status;
this.code = code;
this.error = error;
}

public static List<RestFieldError> toRestFieldErrorList(List<FieldError> errors) {
List<RestFieldError> fieldErrors = new ArrayList<>(errors.size());
for (FieldError error : errors) {
fieldErrors.add(new RestFieldError(error));
}
return fieldErrors;
}

public List<RestFieldError> getErrors() {
return error;
}

public void setErrors(List<RestFieldError> error) {
this.error = error;
}

public HttpStatus getStatus() {
return status;
}

public int getCode() {
return code;
}

private String getMessageKey() {
String simpleName = this.getClass().getSimpleName();
return simpleName.substring(0, simpleName.lastIndexOf("Exception"));
}
}

// 添加
@RequestMapping(value = "/emp", method = RequestMethod.POST)
public void add(@RequestBody @Valid Employee employee, BindingResult result, Locale locale) {
System.out.println(employee);
if (!validateLastName(employee.getLastName())) {
throw new UsernameExistedException(employee.getLastName(), locale);
} else if (result.hasErrors()) {
throw new ValidationException(result.getFieldErrors());
}
System.out.println("add:" + employee);
employeeService.save(employee);
}

public class UsernameExistedException extends BaseRestException {
private static final HttpStatus STATUS = HttpStatus.CONFLICT;
private static final int CODE = 42201;

/**
*
*/
private static final long serialVersionUID = 6915629262486503046L;

public UsernameExistedException(String lastName, Locale locale) {
super(STATUS, CODE, locale, "lastName", lastName);
}

}

public class ValidationException extends BaseRestException {
private static final HttpStatus STATUS = HttpStatus.BAD_REQUEST;
private static final int CODE = 40001;

/**
*
*/
private static final long serialVersionUID = 5495053837578511264L;

public ValidationException(List<FieldError> errors) {
super(STATUS, CODE,  toRestFieldErrorList(errors));
}
}

八、项目部署

九、项目演示

postman

十、文档管理

十一、项目总结

源码分享

关于技术

Spring Data

Redis

Spring

Spring MVC

题外话

预告