IDEA统一注释格式(干货）

统一注释格式：

Idea自动生成注释：

 

/**

*@author 你的名字的简写


*@date ${DATE}${TIME}

 

 

在每个功能上添加注释，例子如下：

我在Mapper文件中添加了自己书写的Sql语句那么加上注释：

 

在maapper.xml文件中这样写：

 

Service层：

 

ServiceImpl层：

 

Controller层：

 

分页书写格式：

使用pager进行分页展示

//首先Service层的书写,例如：

 ServerResponse  selectUserAll(int curentPageIndex,int countPerpage);

 //Impl实现层的书写，例如：

 public ServerResponse selectUserAll(int curentPageIndex,int countPerpage) {

        UserExample example = new UserExample();

        UserExample.Criteria criteria = example.createCriteria();

 

        List 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 fingdAllUser(

                            @RequestParam(value = "curentPageIndex", defaultValue = "1") int curentPageIndex,

            @RequestParam(value = "countPerpage", defaultValue = "10") int countPerpage) {

       

                   return testService.selectUserAll(countPerpage, curentPageIndex);

 }

 

比如按照id或者名字进行多种方式的查询：

根据id或者名字进行查询：

//mapper层
List selectAllByIdAndTel(User user);

//在xml文件中书写代码：

 

    select

   

    from user

   

         <--注意这个if test中的userId和name,这两个字段是user实体类中的变量，and 后面的User_id和Name是数据库User表中的字段-->

     

         and User_id=#{userId}

     

     

        and Name LIKE '%' #{name} '%'

     

   

 

 

 

//Servcie层

//我这个写的时候是按照分页格式写的，实际上查询出来的一般是单条数据

 ServerResponse selectAllByIdAndTel(User user);

 

 

// ServiceImpl实现层

 

    @Override

    public ServerResponse selectAllByIdAndTel(User user) {

            UserExample example=new UserExample();

        UserExample.Criteria criteria=example.createCriteria();

        Pager pager=new Pager();

        List 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 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实体类中的变量。