從零開(kāi)始學(xué)習(xí)Spring Boot也有幾天時(shí)間了，項(xiàng)目已經(jīng)不允許我這么慢慢學(xué)習(xí)了责循，急需底層變現(xiàn)實(shí)現(xiàn)一套簡(jiǎn)單的Restful API用于業(yè)務(wù)支撐把跨。
于是在GitHub上找到了一個(gè)不錯(cuò)的demo，直接看demo搭建自己的項(xiàng)目了沼死，這里記錄下在搭建過(guò)程中學(xué)習(xí)到的和遇到的問(wèn)題着逐。
先說(shuō)說(shuō)這個(gè)項(xiàng)目吧，項(xiàng)目結(jié)構(gòu)意蛀，配置等非常精簡(jiǎn)耸别，對(duì)于新手的我來(lái)說(shuō)還是比較容易上手的，對(duì)于學(xué)習(xí)和開(kāi)發(fā)很有幫助县钥，給作者點(diǎn)贊秀姐。
在此基礎(chǔ)上做了點(diǎn)滿足自身需求的改動(dòng)，同時(shí)加入了swagger若贮，順利的搭建了一套服務(wù)省有。
代碼自動(dòng)生成
底層服務(wù)有很多通用的CRUD痒留，利用代碼生成最好不過(guò)了，這里作者將代碼生成放在test中的 CodeGenerator蠢沿，避免與正式代碼沖突伸头。
生成的代碼不細(xì)說(shuō)了，大家可以慢慢理解舷蟀，覺(jué)得有困難的可以直接拿過(guò)來(lái)用恤磷。
主要通過(guò)org.mybatis.generator來(lái)實(shí)現(xiàn)，項(xiàng)目中的generator.template模板文件可以自行定義野宜。
Mybatis及分頁(yè)插件配置
首先引用分頁(yè)插件包：
<dependency>
<groupId>com.github.pagehelper</groupId>
<artifactId>pagehelper</artifactId>
<version>4.2.1</version>
</dependency>
然后進(jìn)行相應(yīng)的配置：
@Bean
public SqlSessionFactory sqlSessionFactoryBean(DataSource dataSource) throws Exception {
SqlSessionFactoryBean factory = new SqlSessionFactoryBean();
factory.setDataSource(dataSource);
factory.setTypeAliasesPackage(MODEL_PACKAGE);
//配置分頁(yè)插件扫步，詳情請(qǐng)查閱官方文檔
PageHelper pageHelper = new PageHelper();
Properties properties = new Properties();
properties.setProperty("pageSizeZero", "true");//分頁(yè)尺寸為0時(shí)查詢所有紀(jì)錄不再執(zhí)行分頁(yè)
properties.setProperty("reasonable", "true");//頁(yè)碼<=0 查詢第一頁(yè)，頁(yè)碼>=總頁(yè)數(shù)查詢最后一頁(yè)
properties.setProperty("supportMethodsArguments", "true");//支持通過(guò) Mapper 接口參數(shù)來(lái)傳遞分頁(yè)參數(shù)
pageHelper.setProperties(properties);
//添加插件
factory.setPlugins(new Interceptor[]{pageHelper});
//添加X(jué)ML目錄
ResourcePatternResolver resolver = new PathMatchingResourcePatternResolver();
factory.setMapperLocations(resolver.getResources("classpath:mapper/*.xml"));
return factory.getObject();
}
通用Mapper配置
引用通用mapper匈子，簡(jiǎn)單的增刪改查就不用再寫(xiě)對(duì)應(yīng)的xml了河胎，之后有新增字段只要修改對(duì)應(yīng)的model就可以了，還是非常方便的虎敦。
引用對(duì)應(yīng)的包：
<dependency>
<groupId>tk.mybatis</groupId>
<artifactId>mapper</artifactId>
<version>3.4.2</version>
</dependency>
然后進(jìn)行相應(yīng)的配置：
@Bean
public MapperScannerConfigurer mapperScannerConfigurer() {
MapperScannerConfigurer mapperScannerConfigurer = new MapperScannerConfigurer();
mapperScannerConfigurer.setSqlSessionFactoryBeanName("sqlSessionFactoryBean");
mapperScannerConfigurer.setBasePackage(MAPPER_PACKAGE);
//配置通用Mapper游岳，詳情請(qǐng)查閱官方文檔
Properties properties = new Properties();
properties.setProperty("mappers", MAPPER_INTERFACE_REFERENCE);
properties.setProperty("notEmpty", "false");//insert、update是否判斷字符串類(lèi)型!='' 即 test="str != null"表達(dá)式內(nèi)是否追加 and str != ''
properties.setProperty("IDENTITY", "MYSQL");
mapperScannerConfigurer.setProperties(properties);
return mapperScannerConfigurer;
}
生成代碼的實(shí)現(xiàn)
在分頁(yè)組件原茅，通用mapper都配置完之后，我們需要通過(guò)自動(dòng)生成堕仔，根據(jù)自定義模板生成我們所需要的Model擂橘、Mapper、MapperXML摩骨、Service通贞、ServiceImpl、Controller對(duì)應(yīng)的基礎(chǔ)代碼恼五。
首先是模板的定義昌罩，定義常用的變量，定制你的代碼灾馒，比如service模板,這樣只要替換對(duì)應(yīng)的變量就可以達(dá)到生成需要的代碼的目的茎用。
package ${basePackage}.service;
import ${basePackage}.model.${modelNameUpperCamel};
import ${basePackage}.common.Service;
/**
* Created by ${author} on ${date}.
*/
public interface ${modelNameUpperCamel}Service extends Service<${modelNameUpperCamel}> {
}
然后需要編寫(xiě)下基于通用MyBatis Mapper插件的Service接口的實(shí)現(xiàn),從而在生成模板中根據(jù)該規(guī)則打通mapper與service層。
public abstract class AbstractService<T> implements Service<T> {
@Autowired
protected Mapper<T> mapper;
private Class<T> modelClass; // 當(dāng)前泛型真實(shí)類(lèi)型的Class
public AbstractService() {
ParameterizedType pt = (ParameterizedType) this.getClass().getGenericSuperclass();
modelClass = (Class<T>) pt.getActualTypeArguments()[0];
}
public void save(T model) {
mapper.insertSelective(model);
}
public void save(List<T> models) {
mapper.insertList(models);
}
public void deleteById(Long id) {
mapper.deleteByPrimaryKey(id);
}
public void deleteByIds(String ids) {
mapper.deleteByIds(ids);
}
public void update(T model) {
mapper.updateByPrimaryKeySelective(model);
}
public T findById(Long id) {
return mapper.selectByPrimaryKey(id);
}
@Override
public T findBy(String fieldName, Object value) throws TooManyResultsException {
try {
T model = modelClass.newInstance();
Field field = modelClass.getDeclaredField(fieldName);
field.setAccessible(true);
field.set(model, value);
return mapper.selectOne(model);
} catch (ReflectiveOperationException e) {
throw new ServiceException(e.getMessage(), e);
}
}
public List<T> findByIds(String ids) {
return mapper.selectByIds(ids);
}
public List<T> findByCondition(Condition condition) {
return mapper.selectByCondition(condition);
}
public List<T> findAll() {
return mapper.selectAll();
}
}
具體的詳細(xì)代碼可以看下demo睬罗。
統(tǒng)一響應(yīng)結(jié)果和異常處理
在配置springMVC時(shí)轨功，通過(guò)繼承WebMvcConfigurerAdapter，重寫(xiě)對(duì)應(yīng)的方法容达，實(shí)現(xiàn)我們一些定制化的需求古涧。
使用FastJson
阿里的fstjson轉(zhuǎn)化效率還是比較高的，我們統(tǒng)一替換：
@Override
public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
FastJsonHttpMessageConverter converter = new FastJsonHttpMessageConverter();
FastJsonConfig config = new FastJsonConfig();
config.setSerializerFeatures(SerializerFeature.WriteMapNullValue,//保留空的字段
SerializerFeature.WriteNullStringAsEmpty,//String null -> ""
SerializerFeature.WriteNullNumberAsZero);//Number null -> 0
converter.setFastJsonConfig(config);
converter.setDefaultCharset(Charset.forName("UTF-8"));
converters.add(converter);
}
統(tǒng)一異常處理
統(tǒng)一異常捕獲花盐，在業(yè)務(wù)失敗直接使用ServiceException("message")拋出羡滑，統(tǒng)一輸出{"code":400,"message":"這里是錯(cuò)誤消息"}
@Override
public void configureHandlerExceptionResolvers(List<HandlerExceptionResolver> exceptionResolvers) {
exceptionResolvers.add((request, response, handler, e) -> {
Result result = new Result();
if (e instanceof ServiceException) {//業(yè)務(wù)失敗的異常菇爪，如“賬號(hào)或密碼錯(cuò)誤”
result.setCode(ResultCode.FAIL).setMessage(e.getMessage());
logger.info(e.getMessage());
} else if (e instanceof NoHandlerFoundException) {
result.setCode(ResultCode.NOT_FOUND).setMessage("接口 [" + request.getRequestURI() + "] 不存在");
} else if (e instanceof ServletException) {
result.setCode(ResultCode.FAIL).setMessage(e.getMessage());
} else {
result.setCode(ResultCode.INTERNAL_SERVER_ERROR).setMessage("接口 [" + request.getRequestURI() + "] 內(nèi)部錯(cuò)誤，請(qǐng)聯(lián)系管理員");
String message;
if (handler instanceof HandlerMethod) {
HandlerMethod handlerMethod = (HandlerMethod) handler;
message = String.format("接口 [%s] 出現(xiàn)異常柒昏，方法：%s.%s凳宙，異常摘要：%s",
request.getRequestURI(),
handlerMethod.getBean().getClass().getName(),
handlerMethod.getMethod().getName(),
e.getMessage());
} else {
message = e.getMessage();
}
logger.error(message, e);
}
responseResult(response, result);
return new ModelAndView();
});
}
統(tǒng)一攔截器
可以通過(guò)重寫(xiě)addInterceptors方法來(lái)自定義攔截，比如說(shuō)用戶登錄昙楚，token驗(yàn)證等近速。
@Override
public void addInterceptors(InterceptorRegistry registry) {
//具體實(shí)現(xiàn)
}
添加Swagger
之前的文章有具體介紹配置Swagger，這里只要在之前的基礎(chǔ)上在springMVC配置項(xiàng)下添加swagger資源即可：
@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
registry.addResourceHandler("swagger-ui.html")
.addResourceLocations("classpath:/META-INF/resources/");
registry.addResourceHandler("/webjars/**")
.addResourceLocations("classpath:/META-INF/resources/webjars/");
}
實(shí)現(xiàn)效果如下堪旧，基本單表的操作不需要你編寫(xiě)代碼了：
項(xiàng)目的基本內(nèi)容介紹到這里削葱，具體的還是需要大家自行去看想代碼，實(shí)際操作一下淳梦。
總結(jié)
看代碼的學(xué)習(xí)效率還是比看書(shū)快的析砸，多實(shí)踐，實(shí)踐完看原理爆袍，感覺(jué)這樣最好首繁。
如果想獲取對(duì)應(yīng)的代碼，可以關(guān)注我的公眾號(hào)：Bug生活2048陨囊，回復(fù)SpringBoot就可以啦弦疮。
相互學(xué)習(xí)，共同進(jìn)步～
