IDEA統一註釋格式(乾貨）
統一註釋格式：
Idea自動生成註釋：
/**
*@author 你的名字的簡寫
*@date ${DATE}${TIME}
在每個功能上添加註釋，例子如下：
我在Mapper檔案中添加了自己書寫的Sql語句那麼加上註釋：
在maapper.xml檔案中這樣寫：
Service層：
ServiceImpl層：
Controller層：
分頁書寫格式：
使用pager進行分頁展示
//首先Service層的書寫,例如：
ServerResponse<Pager> selectUserAll(int curentPageIndex,int countPerpage);
//Impl實現層的書寫，例如：
public ServerResponse<Pager> selectUserAll(int curentPageIndex,int countPerpage) {
UserExample example = new UserExample();
UserExample.Criteria criteria = example.createCriteria();
List<User> users = userMapper.selectByExample(example);
Pager pager=new Pager();//建立pager物件
if(users.size()>0){//判斷是否含有資料
pager.setBigList(users);//把list物件放入pager中大的集合
pager.setCurentPageIndex(curentPageIndex);//設定pager當前頁
pager.setCountPerpage(countPerpage);//設定pager一頁含有總數
ServerResponse serverResponse=ServerResponse.createBySuccess(pager.getSmallList(),"查詢成功",users.size());//這裡傳給serverResponse的是
//pager中的小集合。
return serverResponse;
}else {
return ServerResponse.createByErrorMessage("查詢失敗");
}
}
//controller層：
public ServerResponse<Pager> fingdAllUser(
@RequestParam(value = "curentPageIndex", defaultValue = "1") int curentPageIndex,
@RequestParam(value = "countPerpage", defaultValue = "10") int countPerpage) {
return testService.selectUserAll(countPerpage, curentPageIndex);
}
比如按照id或者名字進行多種方式的查詢：
根據id或者名字進行查詢：
//mapper層
List<User> selectAllByIdAndTel(User user);
//在xml檔案中書寫程式碼：
<!--根據id或者name進行查詢資訊-->
<select id="selectAllByIdAndTel" parameterType="com.kude.pojo.User" resultMap="BaseResultMap">
select
<include refid="Base_Column_List" />
from user
<where>
<--注意這個if test中的userId和name,這兩個欄位是user實體類中的變數，and 後面的User_id和Name是資料庫User表中的欄位-->
<if test="userId!= null and userId!=''">
and User_id=#{userId}
</if>
<if test="name!= null and name!=''">
and Name LIKE '%' #{name} '%'
</if>
</where>
</select>
//Servcie層
//我這個寫的時候是按照分頁格式寫的，實際上查詢出來的一般是單條資料
ServerResponse<Pager> selectAllByIdAndTel(User user);
// ServiceImpl實現層
@Override
public ServerResponse<Pager> selectAllByIdAndTel(User user) {
UserExample example=new UserExample();
UserExample.Criteria criteria=example.createCriteria();
Pager pager=new Pager();
List<User> users=userMapper.selectAllByIdAndTel(user);
if(users.size()>0){//判斷是否含有資料
pager.setBigList(users);
pager.setCurentPageIndex(curentPageIndex);//當前頁數
pager.setCountPerpage(countPerpage);//總頁數
ServerResponse serverResponse=ServerResponse.createBySuccess(pager.getSmallList(),"查詢成功",users.size());
return serverResponse;
}else {
return ServerResponse.createByErrorMessage("查詢失敗");
}
}
//Controller控制器
@RequestMapping("/test/selectAllByIdAndTel.do")
@ResponseBody
public ServerResponse<Pager> selectAllByIdAndTel(User user){
return testService.selectAllByIdAndTel(user,curentPageIndex,countPerpage);
}
//進行測試的介面：
http://localhost:8080/user//test/selectAllByIdAndTel.do?name=張三
或者測試
http://localhost:8080/user//test/selectAllByIdAndTel.do?userId=1
特別注意介面中的name和userId也是屬於User實體類中的變數。
&n