JDK1.5出來後,Java開始支持泛型開發,通過將父類聲明爲泛型,子類繼承父類,子類就能擁有父類的方法,而不需要再寫代碼。泛型開發能使我們的代碼開發提供了很大的簡便,簡化了我們的代碼。
在springboot項目中(其他項目也一樣),我們經常要用到增刪改查接口,從controller/service/dao層,每一層都要寫增刪改查代碼,每一張數據表都要重複一遍增刪改查功能。雖然寫起來簡單,但是作爲程序員來講,寫重複性的代碼就是在浪費時間,浪費生命。
程序員的主要精力應該放在如何實現業務上面。
下面我們來看下怎樣通過泛型開發來封裝代碼,簡化開發。
一、聲明泛型父類
泛型父類包括:controller/service/dao三層。
1、聲明泛型虛基類AbstractController,定義接口方法:
public abstract class AbstractController<T, K>{
/**
* 新增
* @param t
* @return
*/
public abstract RtnData insert(T t);
/**
* 修改
* @param t
* @return
*/
public abstract RtnData update(T t);
/**
* 刪除
* @param
* @return
*/
public abstract RtnData delete(K id);
/**
* 按主鍵查詢
* @param
* @return
*/
public abstract RtnData get(K Id);
/**
* 分頁查詢
* @return
*/
public abstract RtnData queryPageList(int pageSize, int pageIndex, Map<String,Object> params);
/**
* 多條件查詢
* @return
*/
public abstract RtnData queryList(Map<String,Object> params);
}
2、實現泛型父類BaseController,繼承 AbstractController
這裏我們定義泛型父類BaseController,繼承並實現AbstractController方法,並且在BaseController中定義每個方法的RequestMapping。這樣業務類直接繼承BaseController就可以使用默認實現好的增刪改查接口了。
public class BaseController<T, K> extends AbstractController<T, K> {
@Autowired
private IService<T, K> service;
@PostMapping("/insert")
@Override
public RtnData insert(@RequestBody T t) {
return RtnData.ok(service.insert(t));
}
@PostMapping("/update")
@Override
public RtnData update(@RequestBody T t) {
return RtnData.ok(service.update(t));
}
@GetMapping("/delete")
@Override
public RtnData delete(K id) {
return RtnData.ok(service.delete(id));
}
@GetMapping("/get")
@Override
public RtnData get(K id) {
return RtnData.ok(service.get(id));
}
@GetMapping("/page-list")
@Override
public RtnData queryPageList(@RequestParam(required = false, defaultValue = "20") int pageSize,
@RequestParam(required = false, defaultValue = "1") int pageIndex,
@RequestParam Map<String,Object> params) {
return RtnData.ok(service.queryPageList(pageSize, pageIndex, params));
}
@GetMapping("/list")
@Override
public RtnData queryList(@RequestParam Map<String, Object> params) {
return RtnData.ok(service.queryList(params));
}
}
BaseController注入了泛型IService,用於實現具體的業務操作
3、聲明泛型業務接口類IService
public interface IService<T,K>{
/**
* 新增
* @param t
* @return
*/
public Object insert(T t);
/**
* 修改
* @param t
* @return
*/
public Object update(T t);
/**
* 刪除
* @param
* @return
*/
public Object delete(K id);
/**
* 按主鍵查詢
* @param
* @return
*/
public T get(K id);
/**
* 分頁查詢
* @param pageSize
* @param pageIndex
* @param params
* @return
*/
Object queryPageList(int pageSize, int pageIndex, Map<String, Object> params);
/**
* 條件查詢
* @param params
* @return
*/
Object queryList(Map<String, Object> params);
}
4、定義泛型業務類BaseService,實現IService類
BaseService實現IService接口中發方法,編寫增刪改查操作默認業務實現。子類通過繼承BaseService就擁有它的方法。
public class BaseService<T,K> implements IService<T,K> {
@Autowired
protected Mapper<T, K> mapper;
private Class<T> modelClass;//當前泛型的真實類型Class
public BaseService() {
ParameterizedType pt = (ParameterizedType) this.getClass().getGenericSuperclass();
modelClass = (Class<T>) pt.getActualTypeArguments()[0];
}
@Override
public Object insert(T t) {
return mapper.insert(t);
}
@Override
public Object update(T t) {
return mapper.updateByPrimaryKey(t);
}
@Override
public Object delete(K id) {
return mapper.deleteByPrimaryKey(id);
}
@Override
public T get(K id) {
return mapper.selectByPrimaryKey(id);
}
@Override
public Object queryPageList(int pageSize, int pageIndex, Map<String, Object> params) {
PageHelper.startPage(pageIndex, pageSize);
Page page = mapper.queryPageList(params);//Page本身是一個ArrayList對象,轉換爲json時不會保留分頁信息
PageInfo pageInfo = page.toPageInfo();//將page轉換成pageInfo會保存分頁信息返回
return new PageModel(pageInfo);
}
@Override
public Object queryList(Map<String, Object> params) {
return mapper.queryList(params);
}
}
這裏最重要的兩行代碼:
ParameterizedType pt = (ParameterizedType) this.getClass().getGenericSuperclass();
modelClass = (Class) pt.getActualTypeArguments()[0];
通過泛型反射,獲取子類中實際要操作的對象class,通過class,service就知道要對哪個對象進行增刪改查操操作。
另外,我們注入了dao層的泛型Mapper<T, K>,通過Mybatis對數據庫進行增刪改查操作
5、聲明Dao層泛型Mapper
public interface Mapper<T, K> {
int deleteByPrimaryKey(K id);
int insert(T record);
int insertSelective(T record);
T selectByPrimaryKey(K id);
int updateByPrimaryKeySelective(T record);
int updateByPrimaryKey(T record);
/**
* 分頁查詢(由子類實現)
* @param params
* @return
*/
Page queryPageList(Map<String, Object> params);
/**
* 多條件查詢(由子類實現)
* @param params
* @return
*/
List<Map<String,Object>> queryList(Map<String, Object> params);
}
這裏我們使用mybatis實現dao層的操作,這裏的聲明的接口方法名稱與mybatis工具生成mapper.xml一致
到這裏,我們的泛型父類代碼已經全部編寫完成。可以將上述代碼達成jar包,放入項目裏面作爲基礎包直接引用。
下面我們來說說怎麼在項目裏面實際使用。
二、項目應用
在項目裏面引用,只需在子類代碼層中繼承上述父類,子類就擁有父類中的功能。
1、子類Controller
@RestController
@RequestMapping("/api/dic")
public class DataDicController extends BaseController<DataDic, Integer> {
}
看到沒,裏面什麼方法也沒寫,只聲明瞭RequestMapping,另外將泛型用具體對象類型替換。
DataDic是我操作的對象,Integer是DataDic的主鍵類型。
這個BaseController的新增接口地址是/api/dic/insert,/insert是使用父類的RequestMapping。
另外我也沒寫Service的注入,因爲容器會根據要父類中要注入的泛型Service,直接找到IService對應的泛型實例
2、子類Service
@Service
public class DataDicService extends BaseService<DataDic, Integer> {
}
同樣,Service也沒有任何代碼,也沒有注入Mapper,只繼承了泛型
3、子類Mapper
@Mapper
public interface DataDicMapper extends com.cc.app.base.dao.Mapper<DataDic, Integer> {
}
Mapper需要繼承我們自己定義的泛型Mapper,這樣才能被Service找到。
說明:我們通過工具生成的Mapper對象會包含默認的方法,大家不用刪除,因爲和繼承的Mapper方法名一致,就當是覆蓋Override
到此,所有工作結束,我們的DataDicController的增刪改查接口寫好 ,下面我們來測試。
三、接口測試
1、查詢接口get
2、插入接口insert