SpringBoot中怎样对外开放一个接口返回Json数据

r囧r小猫 2023-10-18 16:50 107阅读 0赞

## 场景 ##

在SpringBoot中开放一个接口，使C\#程序中能访问接口并接受返回的数据、

## 实现 ##

封装一个Json类

import lombok.Data;
    
    import java.io.Serializable;
    
    @Data
    public class Json implements Serializable {
        //默认未失败状态
        private static Json instance;
        private String msg = "接口访问失败";
        private String title = "失败提示";
        private boolean status = false;
        private int code = 300;
        private Object data = null;
    
        public synchronized static Json getInst() {
            if(instance==null){
                instance = new Json();
            }
            return instance;
        }
    
        public Json() {
            super();
        }
    
        public Json success(Object data){
            this.title = "成功提示";
            this.msg = "接口访问成功";
            this.status = true;
            this.code = 200;
            this.data = data;
            return this;
        }
    
        public Json success(){
            this.title = "成功提示";
            this.msg = "接口访问成功";
            this.status = true;
            this.code = 200;
            this.data = null;
            return this;
        }
    
        public Json fail(Object data){
            this.title = "失败提示";
            this.msg = "接口访问失败";
            this.status = false;
            this.code = 300;
            this.data = data;
            return this;
        }
    
        public Json fail(){
            this.title = "失败提示";
            this.msg = "接口访问失败";
            this.status = false;
            this.code = 300;
            this.data = null;
            return this;
        }
    }

在SpringBoot项目中的Controller中新建Controller

@Controller
    @RequestMapping("/wmsCleanWorkShop")
    @EnableConfigurationProperties(ConfigProperties.class)
    public class WmsCleanWorkShopController {
    
        @Autowired
        private ConfigProperties configProperties;
    
        @Resource
        private WmsReceiveOrderDetailsMapper wmsReceiveOrderDetailsMapper;
    
        @Resource
        private WmsReceiveOrderMapper wmsReceiveOrderMapper;
    
        @Resource
        private BusTrayMaterielMapper busTrayMaterielMapper;
    
        @Description("测试接口")
        @RequestMapping(value = "/getStr", method = RequestMethod.POST)//正式改成POST
        @ResponseBody
        public Json getStr(String barCode) {
            try{
             
                //String message = "1";
                if( message.substring(1,message.length()-1).equals("1")){
                    return Json.getInst().success(finalBarCode);
                }else{
                    return Json.getInst().fail("失败：调用接口失败");
                }
    
            }catch (Exception e){
                return Json.getInst().fail("生成失败:出现异常"+e.toString());
            }
        }
    }

## 效果 ##

直接使用浏览器访问是get方式，需要将

@RequestMapping(value = "/getStr", method = RequestMethod.GET)//正式改成POST

这里修改

为了测试POST方式，这里使用Postman进行测试

![Image 1][]![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBREFPX0xJVU1BTkdfUUlaSEk_size_16_color_FFFFFF_t_70][]

可以看到后台能接收到数据，然后进行相应的逻辑处理即可，这里不做处理使其返回失败。

![Image 1][]  
![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBREFPX0xJVU1BTkdfUUlaSEk_size_16_color_FFFFFF_t_70 1][]

[Image 1]: 
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBREFPX0xJVU1BTkdfUUlaSEk_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20190409172823344.jpg?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBREFPX0xJVU1BTkdfUUlaSEk=,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBREFPX0xJVU1BTkdfUUlaSEk_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20190409172831562.jpg?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBREFPX0xJVU1BTkdfUUlaSEk=,size_16,color_FFFFFF,t_70