首页 > 其他分享 >pringboot之restfull接口规范注解(二)

pringboot之restfull接口规范注解(二)

时间:2023-04-18 15:04:45浏览次数:43  
标签:pringboot name jdbc restfull student mybatis 注解 id

1,springboot逆向mybatis生成接口类

pom依赖包

<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
</dependency>
<dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter</artifactId>
    <version>2.1.0</version>
</dependency>

pom依赖插件

<plugin>
    <groupId>org.mybatis.generator</groupId>
    <artifactId>mybatis-generator-maven-plugin</artifactId>

    <version>1.3.5</version>
    <configuration>
        <verbose>true</verbose>
        <overwrite>true</overwrite>
    </configuration>
</plugin>

generator.properties配置文件

jdbc.driverLocation=D:/mysql-connector-java-8.0.16.jar
jdbc.driverClass=com.mysql.cj.jdbc.Driver
jdbc.connectionURL=jdbc:mysql://localhost:3306/test
jdbc.userId=root
jdbc.password=root

generatorConfig.xml文件

javaModelGenerator 模块生成的路径
sqlMapGenerator Mapper映射文件生成所在的目录 为每一个数据库的表生成对应的SqlMap文件,一般指的到resource下新建一个mapper文件夹里面 targetProject="src/main/resource">
javaClientGenerator Mapper接口的文件路径 targetProject="src/main/java" type="XMLMAPPER">
table 数据库表名称
                          ```xml
                          <?xml version="1.0" encoding="UTF-8"?>
                          <!DOCTYPE generatorConfiguration
                                  PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
                                  "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">

                          <generatorConfiguration>
                              <!--导入属性配置-->
                              <properties resource="generator.properties"></properties>

                              <!--指定特定数据库的jdbc驱动jar包的位置-->
                              <classPathEntry location="${jdbc.driverLocation}"/>

                              <context id="default" targetRuntime="MyBatis3">

                                  <!-- optional,旨在创建class时,对注释进行控制 -->
                                  <commentGenerator>
                                      <property name="suppressDate" value="true"/>
                                      <property name="suppressAllComments" value="true"/>
                                  </commentGenerator>

                                  <!--jdbc的数据库连接 -->
                                  <jdbcConnection
                                          driverClass="${jdbc.driverClass}"
                                          connectionURL="${jdbc.connectionURL}"
                                          userId="${jdbc.userId}"
                                          password="${jdbc.password}">
                                      <!--MySQL 不支持 schema 或者 catalog 所以需要添加这个-->
                                      <!-- 不然会出现生成器把其他数据库的同名表生成下来的问题 -->
                                      <!-- 现象就是某个类中出现了数据库表里面没有的字段 -->
                                      <property name="nullCatalogMeansCurrent" value="true"/>
                                  </jdbcConnection>


                                  <!-- 非必需,类型处理器,在数据库类型和java类型之间的转换控制-->
                                  <javaTypeResolver>
                                      <property name="forceBigDecimals" value="false"/>
                                  </javaTypeResolver>


                                  <!-- Model模型生成器,用来生成含有主键key的类,记录类 以及查询Example类
                                      targetPackage     指定生成的model生成所在的包名
                                      targetProject     指定在该项目下所在的路径
                                  -->
                                  <javaModelGenerator targetPackage="com.example.test001.bean"
                                                      targetProject="src/main/java">

                                      <!-- 是否允许子包,即targetPackage.schemaName.tableName -->
                                      <property name="enableSubPackages" value="false"/>
                                      <!-- 是否对model添加 构造函数 -->
                                      <property name="constructorBased" value="true"/>
                                      <!-- 是否对类CHAR类型的列的数据进行trim操作 -->
                                      <property name="trimStrings" value="true"/>
                                      <!-- 建立的Model对象是否 不可改变  即生成的Model对象不会有 setter方法,只有构造方法 -->
                                      <property name="immutable" value="false"/>
                                  </javaModelGenerator>

                                  <!--Mapper映射文件生成所在的目录 为每一个数据库的表生成对应的SqlMap文件 -->
                                  <sqlMapGenerator targetPackage="mapper"
                                                   targetProject="src/main/resource">
                                      <property name="enableSubPackages" value="false"/>
                                  </sqlMapGenerator>

                                  <!-- 客户端代码,生成易于使用的针对Model对象和XML配置文件 的代码
                                          type="ANNOTATEDMAPPER",生成Java Model 和基于注解的Mapper对象
                                          type="MIXEDMAPPER",生成基于注解的Java Model 和相应的Mapper对象
                                          type="XMLMAPPER",生成SQLMap XML文件和独立的Mapper接口
                                  -->
                                  <javaClientGenerator targetPackage="com.example.test001.mapper"
                                                       targetProject="src/main/java" type="XMLMAPPER">
                                      <property name="enableSubPackages" value="true"/>
                                  </javaClientGenerator>

                                  <!--要执行逆向工程所用到的表-->
                                  <table tableName="user" />
                          <!--        <table tableName="category" />-->
                              </context>
                          </generatorConfiguration>
                          ```

2,执行generator生成接口类

1,控制台使用mvn命令:
mvn mybatis-generator:generate
2,双击mvn里面的pulgins插件下的renerator启动插件

image-20220522232558311

执行完成后就会生成三个文件

image-20220522232829247

3,创建一个控制器

注解 说明 例子
@RestController 在类上添加注解,相当于在类上添加@Controller和在方法上添加@ ResponseBody二合一,在类上加了@RestController注解后就不在在每个方法上加@ResponseBody注解了 @RestController
public class StudentController {}
@Autowired 自动注入注解的对象 @Autowired
private StudentService studentService;
@GetMapping get请求的注解,相当于@RequestMapping(value = "/get",method = RequestMethod.GET),后面的port,put,delete用法都是一样 @GetMapping(value = "/get/{id}")
@PathVariable 路径变量,识别注解上面的变量,如 "/get/{id}",id变量可以通过这个注解识别 public Object getName(@PathVariable( "id") Integer id){}
@PathParam 定义一个参数,不加这个注解,默认取的是形式参数的变量名 public Object inster(
@PathParam("name") String name){}

​ ```

package com.springboot.test002.web;

import com.springboot.test002.model.Student;
import com.springboot.test002.service.StudentService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

import javax.websocket.server.PathParam;
import java.util.HashMap;

/**
 * restfull接口案例,连接数据库进行增删改差
 */
@RestController
public class StudentController {
    @Autowired
    private StudentService studentService;

    @GetMapping(value = "/get/{id}")
    public Object getName(@PathVariable( "id") Integer id){
        HashMap<Object, Object> objectObjectHashMap = new HashMap<>();
        objectObjectHashMap.put("id",id);
        return objectObjectHashMap;
    }

    @PostMapping(value = "/inster")
    public Object inster(
                         @PathParam("name") String name,
                         @PathParam("age") Integer age,
                         @PathParam("passwod") String password){
        HashMap<Object, Object> objectObjectHashMap = new HashMap<>();
        objectObjectHashMap.put("name",name);
        objectObjectHashMap.put("age",age);
        objectObjectHashMap.put("passwod",password);
       int i =  studentService.inster(objectObjectHashMap);
        return i ;
    }
    @PutMapping(value = "/update/{id}")
    public Object update(@PathVariable("id") Integer id,
                         @PathParam("name") String name,
                         @PathParam("age") Integer age,
                         @PathParam("password") String password){
        Student student = new Student();
        student.setId(id);
        student.setName(name);
        student.setAge(age);
        student.setPasswod(password);
        int i =  studentService.update(student);
        return i ;
    }
    @DeleteMapping(value = "/delete/{id}")
    public Object delete(
            @PathVariable( "id") Integer id){
        Student student = new Student();
        student.setId(id);
         return   studentService.delete(student.getId());
    }

    @RequestMapping(value = "/getUser")
    public Object get(Integer id){
        Student student = new Student();
        student.setId(id);
        return   studentService.get(student.getId());
    }
}

4,application配置文件添加引入mapper的xml路径

指定resource路径下的mapper下的所有xml文件

mybatis:
    mapper-locations: classpath:mapper/*.xml

完整的配置文件

  # 应用服务 WEB 访问端口
  server:
      port: 8081
      servlet:
          context-path: /
  spring:
      datasource:
          driver-class-name: com.mysql.cj.jdbc.Driver
          url: jdbc:mysql://localhost:3306/student?serverTimezone=GMT%2B8&&characterEncoding=utf8
          password: root
          username: root
      redis:
          password: 123456
          host: 127.0.0.1
          port: 6379
  mybatis:
      mapper-locations: classpath:mapper/*.xml

5,执行效果

image-20220523000133185

6,测试代码地址

https://github.com/redesperado/SpringBoot


本文永久更新地址:

https://www.fenxiangbe.com/p/pringboot之restfull接口规范注解(二).html

标签:pringboot,name,jdbc,restfull,student,mybatis,注解,id
From: https://www.cnblogs.com/fenxiangbe/p/17329582.html

相关文章

  • Springboot集成dubbo完整过程(三)
    准备工作1,准备mysql服务环境2,准备redis服务环境3,准备zookeeper服务环境4,准备逆向生成bean的xml配置文件5,准备slf4j日志xml配置文件6,准备一个sql脚本1,搭建创建服务工程1,创建一个空的父工程,用来统一管理依赖2,创建一个interface接口工程,主要存放业务bean,接口类3,创建一......
  • SpringBoot学习笔记
    一、Springboot简介目的:设计目的是用来简化Spring应用的初始搭建以及开发过程Spring程序和SpringBoot程序对比SpringBoot项目快速启动对SpringBoot项目打包(执行Maven构建指令package)执行启动命令(cmd中)java-jarspringboot.jar注:jar支持命令行启动需要依赖maven......
  • springboot统一响应实体封装+统一异常类管理
    前言:在日常前后端分离的接口开发过程中,需要我们按相应的格式给前端返回响应的数据,常见的方式就是我们后端自己封装一个包装类,每次返回给前端数据的时候都需要我们自己手动构建一。短时间内来看或许并没有什么,但是一旦接口量变大,我们每个接口都去构建返回值的话,那样就会浪费......
  • Java 4种校验注解(值校验、范围校验、长度校验、格式校验)
    1Maven依赖<!--第一种方式导入校验依赖--><dependency><groupId>javax.validation</groupId><artifactId>validation-api</artifactId><version>2.0.1.Final</version></dependency><!--第二种方式导入校验......
  • Java SpringBoot 7z 压缩、解压
    JavaSpringBoot7z压缩、解压cmd7z文件压缩7z压缩测试添加依赖<dependency><groupId>org.apache.commons</groupId><artifactId>commons-compress</artifactId><version>1.12</version></dependency><dependency......
  • Springboot使用RestTemplate发送Post请求postForEntity (application/json)的坑
    当使用RestTemplate进行http请求时,的确很方便,但是当需要进行post请求时遇到了坑1POST传递参数:采用LinkedMultiValueMap,不能使用HashMapStringurl='http://posturl';MultiValueMap<String,String>map=newLinkedMultiValueMap<String,String>();map.add(......
  • springboot整合swagger2
     1.正文1.1什么是swagger2Swagger是一个规范和完整的框架,用于生成、描述、调用和可视化RESTful风格的Web服务的接口文档 .接口:controller相应的路径方法Swagger2是一款前后端分离开发中非常实用的API管理工具,它可以帮助开发者根据约定规范自动生成API文档,并支持......
  • Spring AOP官方文档学习笔记(二)之基于注解的Spring AOP
    1.@Aspect注解(1)@Aspect注解用于声明一个切面类,我们可在该类中来自定义切面,早在Spring之前,AspectJ框架中就已经存在了这么一个注解,而Spring为了提供统一的注解风格,因此采用了和AspectJ框架相同的注解方式,这便是@Aspect注解的由来,换句话说,在Spring想做AOP框架之前,AspectJAOP框......
  • 笔记springboot0410
    1.课程大纲-springboot框架1.什么是Springboot以及Springboot的特点。2.快速搭建springboot项目3.springboot常用的配置文件类型.4.读取springboot配置文件的内容5.多环境配置6.springboot整合数据源。7.springboot整合mybatis.8.springboot整合定时器。2.什么......
  • SpingROOT注解
    @TableName("CG_WO_FAULT_EXPERT_PAPERS")实体类加这个注解 controller直接可以去查询表了@Accessors(chain=true)注解是用来干嘛的?这个注解是来自与Lombok里的,具体的作用是开启链式编程,让我们写代码更加方便。.排查 经过排查发现是因为 @ApiModel 直接使用不规范导......