说到接口开发,能想到的开发语言有很多种,像什么Java啊、.NET啊、PHP啊、NodeJS啊,太多可以用。为什么选择Java,究其原因,最后只有一个解释,那就是“学Java的人多,人员招聘范围大,有利于团队扩建”。真要说说效率的话,恕我直言,真不如NodeJS(其他的.NET、PHP我不会,O(∩_∩)O~~)。

言归正传,基于Java的框架很多,最终选择了SpringBoot(中间的过程就不说了,折磨了我2天),我们要实现的主要目标,一句话概括“收到前端发送的API接口请求,完成数据以及逻辑处理,返回结果数据”。

一、创建基础工程

1. 打开IDEA -> File -> New -> Project...

创建完工程以后,大概就是上面这个模样(别着急继续,等你的Maven把依赖库下载完,再继续下面的。如果你连Maven都没安装的话,先自行百度把Maven配置好)。

二. 创建项目目录

(庆幸一口气在图片上都标注号了)

多说一句,目录结构,完全可以根据自己的项目需要重新归置,毕竟自己用的顺手才是最重要的。

三、接下来写个样例

controller/Test

package com.univalsoft.springbootapimaster.api.controller;

import com.univalsoft.springbootapimaster.common.controller.BaseController;
import com.univalsoft.springbootapimaster.common.model.APIResponse;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController; @RestController
public class Test extends BaseController { @RequestMapping(value = "/api/test/try", method = RequestMethod.POST)
public APIResponse uploadImage(
@RequestParam(value = "name") String name /* 姓名 */
) { //
if (name.length() < 3) {
return this.fail("[姓名]参数不合法,请重新输入");
} String result = name + ", 欢迎浏览,转载请注明出处!!!(Univalsoft)";
return this.success(result);
}
}

如此简单的代码,就不多说了哈,看不懂的,自觉找个墙角面壁。

运行程序,have a try !

几个重要的基类

1. BaseController

package com.univalsoft.springbootapimaster.common.controller;

import com.univalsoft.springbootapimaster.common.model.APIResponse;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.RestController; import java.util.HashMap; @RestController
public class BaseController { public final Logger logger = LoggerFactory.getLogger(this.getClass()); /**
* 返回成功Response
*
* @param data
* @return
*/
public APIResponse success(Object data) {
logger.info("请求结束 :success: =>", data.toString());
APIResponse res = new APIResponse();
res.success(data);
return res;
} /**
* 分页列表
*
* @param data
* @param pageIndex
* @param pageSize
* @param total
* @return
*/
public APIResponse successWithPage(Object data, int pageIndex, int pageSize, int total) {
logger.info("请求结束 :success: =>", data.toString());
APIResponse res = new APIResponse(); HashMap<String, Object> pageResponse = new HashMap<>();
pageResponse.put("data", data);
pageResponse.put("current", pageIndex);
pageResponse.put("hasMore", pageIndex * pageSize < total);
pageResponse.put("total", total); res.success(pageResponse);
return res;
} /**
* 返回错误Response
*
* @param errmsg
* @return
*/
public APIResponse fail(String errmsg) {
logger.info("请求结束 :fail: =>", errmsg);
APIResponse res = new APIResponse();
res.fail(1, errmsg);
return res;
} }

 

2. APIResponse

package com.univalsoft.springbootapimaster.common.model;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List; public class APIResponse { /**
*
*/
private static final long serialVersionUID = 1L; public static final int ERROR_PARAM_INVALID = 40001;
public static final int ERROR_AUTH_FAIL = 44001; // 认证信息失败 // 信息代码
private int errno;
// 返回信息
private String errmsg;
// 返回内容
private Object data; /**
* 返回错误信息
* @param errno
* @param errmsg
*/
public void fail(int errno, String errmsg) {
this.errno = errno;
this.errmsg = errmsg != null ? errmsg : "";
this.data = ""; // 整体错误
if (errno == ERROR_PARAM_INVALID) {
this.errmsg = "参数不合法";
} else if (errno == ERROR_AUTH_FAIL) {
this.errmsg = "信息认证失败";
}
} /**
* 分页数据查询
*
* @param list 业务数据集合
* @param count 总条数
* @param current 当前页码
* @param pageSize 每页数量
*/
public void setPageData(List list, Integer count, Integer current, Integer pageSize) { HashMap<String, Object> data = new HashMap<>();
data.put("totalAmount", count); // 符合条件的总条数
data.put("current", current); // 当前页码
data.put("amount", (count + pageSize - 1) / pageSize); // 总页数(向上取整) // 容错数组类型
if (list != null) {
data.put("data", list); // 业务数据
} else {
data.put("data", new ArrayList<>()); // 空业务数据
} this.data = data;
} /**
* 返回成功信息
* @param data
*/
public void success(Object data) {
this.errno = 0;
this.errmsg = "";
this.data = data;
} public int getErrno() {
return errno;
} public void setErrno(int errno) {
this.errno = errno;
} public String getErrmsg() {
return errmsg;
} public void setErrmsg(String errmsg) {
this.errmsg = errmsg;
} public Object getData() {
return data;
} public void setData(Object data) {
this.data = data;
}
}

  

好了,基础工程完活。

接口开发-基于SpringBoot创建基础框架的更多相关文章

  1. 封装:简要介绍自定义开发基于WPF的MVC框架

    原文:封装:简要介绍自定义开发基于WPF的MVC框架 一.目的:在使用Asp.net Core时,深感MVC框架作为页面跳转数据处理的方便,但WPF中似乎没有现成的MVC框架,由此自定义开发一套MVC ...

  2. 基于springboot的SSM框架实现返回easyui-tree所需要数据

    1.easyui-tree easui-tree目所需要的数据结构类型如下: [ { "children": [ { "children": [], " ...

  3. PHP扩展开发(1)-创建基础框架

    生成PHP扩展开发的基础框架.   一.Linux下   $>cd ~/{php源码}/ext $>./ext_skel --extname=simple   Creating direc ...

  4. 如莲开发平台(MIS基础框架、Java技术、B/S结构)

    关于     「如莲」是一套MIS类系统基础框架,主要用于各类“管理信息系统”的开发,也适合做网站后台开发.可省去开发时的框架搭建.规范约定.权限管理等基础工作,直接专注于业务功能实现.     「如 ...

  5. 使用vue+elementUI+springboot创建基础后台增删改查的管理页面--(1)

    目前这家公司前端用的是vue框架,由于在之前的公司很少涉及到前端内容,对其的了解也只是会使用js和jquery,所以..慢慢来吧. 在此之前需要先了解vue的大致语法和规则,可先前往官方文档进行学习h ...

  6. 微信开发基于springboot

    0.申请一个微信公众号,记住他的appId,secret,token,accesstoken 1.创建一个springboot项目.在pom文件里面导入微信开发工具类 <dependency&g ...

  7. 使用PHP做移动端 api接口开发方法(适用于TP框架)

    1. [代码]使用TP框架时 放在common文件夹下文件名就叫function.php ? 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 ...

  8. Yii2 advanced版API接口开发 基于RESTful架构的 配置、实现、测试

    参考地址: http://www.xiaoxiangzi.com/Programme/PHP/3348.html http://www.cnblogs.com/ganiks/p/yii2-restfu ...

  9. 从SpringBoot到SpringCloudAlibaba简明教程(一):初识SpringBoot及其基础项目构建

    前言 Spring框架的大名想必大家早已如雷贯耳,我们来看一下springboot诞生的初衷,以及它在springframe的基础上解决了哪些痛点. 很久以前,J2EE还是java企业级应用的标准规范 ...

随机推荐

  1. spark DataFrame 常见操作

    spark dataframe派生于RDD类,但是提供了非常强大的数据操作功能.当然主要对类SQL的支持. 在实际工作中会遇到这样的情况,主要是会进行两个数据集的筛选.合并,重新入库. 首先加载数据集 ...

  2. angularJs入门篇-hello world 开头

    AngularJS 采用了完全不同的解决方案,它创建实时视图模板代替视图,而不是将数据合并进模板之后更新DOM. 任何一个独立视图组件中的值都是 动态替换的.这个功能可以说是AngularJS中最重要 ...

  3. java代码实现图片处理功能。对图片质量进行压缩。

    java图片处理有点头疼,找了很多资料.在这里进行一个汇总,记录下个人的体验,也希望对大家有所帮助. 需求:浏览的图片需要在1M一下. 1.真正对图片的质量进行压缩的(不是通过修改图片的高,宽进行缩小 ...

  4. 20155217 2016-2017-2 《Java程序设计》第5周学习总结

    20155217 2016-2017-2 <Java程序设计>第5周学习总结 教材学习内容总结 第八章 java中所有错误都会被包装为对象,可以尝试(try)执行程序并捕捉(catch)代 ...

  5. vs-code 配置

    vs-code 快键键 命令面板 ctrl+shift+p vs-code 相关插件 AutoFileName Chinese (Simplified) Language Pack for Visua ...

  6. Twisted框架

    Twisted是一个事件驱动型的网络模型.时间驱动模型编程是一种范式,这里程序的执行流由外部决定.特点是:包含一个事件循环,当外部事件发生时,使用回调机制来触发相应的处理. 线程模式: 1.单线程同步 ...

  7. 大数据系列之分布式计算批处理引擎MapReduce实践-排序

    清明刚过,该来学习点新的知识点了. 上次说到关于MapReduce对于文本中词频的统计使用WordCount.如果还有同学不熟悉的可以参考博文大数据系列之分布式计算批处理引擎MapReduce实践. ...

  8. 初始ADO.NET数据操作

    以下介绍直接来源与百度百科,介绍十分全面和详细,作为小菜的我们没有理由不看完这些枯燥的介绍原有: ADO.NET的名称起源于ADO(ActiveX Data Objects),是一个COM组件库,用于 ...

  9. springmvc接收jquery提交的数组数据

    var selectedUsers = $('#users').tagbox('getValues'); if (selectedUsers.length > 0) { $.post(appPa ...

  10. Java实现继承过程概述

    super(); 在调用子类的构造器的时候,如果没有显示的写出 super(); ,那么,编译器会在佛那个加上 super(); 无参构造器 如果想调用父类的有参构造器,那么,必须显示的调用,编译器不 ...