在HC免费开源物业系统中开发接口，很详细

Myth丶恋晨 2024-03-31 15:35 11阅读 0赞

#### 在HC免费开源物业系统中开发接口，很详细 ####

*  一、创建对应的数据表已经对应的DAO
 *  二、创建Service，也就是SMO
 *   *  1、创建测试接口
     *  2、创建对应接口的实现类
     *  3、接着是创建Cmd，也就相当于Controller
 *  三、使用Java110Cmd注解的值注册服务
 *   *  1、先使用dev账号登录
     *  2、在“服务--服务注册--服务绑定”进行服务绑定
     *   *  （1）、选择应用
         *  （2）、选择/添加服务
 *  四、调用接口
 *   *  1、在postman中调用
     *  2、在项目中调用
 *  五、踩坑记录
 *   *  1、可以在服务注册哪里看到绑定的服务信息，但调用接口的时候进不去方法里，打断点也不会停下

最近在捣鼓HC免费开源物业系统，他们的开发文档比较简单，有些细节也没说清楚，因此踩了不少坑，这里做个记录。

这是他们的开发文档

> http://www.homecommunity.cn/devDoc/

我是按照网友贡献的开发接口博客进行接口开发，地址如下：

> http://bbs.homecommunity.cn/document.html?docId=102022061989930248

## 一、创建对应的数据表已经对应的DAO ##

这里我只是想摸索接口是怎么调用的，就没有建表和DAO，网友的博客有说明怎么操作。

## 二、创建Service，也就是SMO ##

### 1、创建测试接口 ###

![在这里插入图片描述][3e6a6059f5274b12b78c17f274b1bfb2.png]

### 2、创建对应接口的实现类 ###

我看了一下，SMO和对应的实现类并不放在同一模块，想放那个模块自行决定，我就放在“service-common ”模块

![在这里插入图片描述][68cd8625aeca4018a2b660c5b99a9879.png]

这是模块的项目模块的介绍

![在这里插入图片描述][d3ffbf0105ee4a5a987cc167f7e56339.png]

地址如下：

> http://bbs.homecommunity.cn/document.html?docId=102022061989930248

### 3、接着是创建Cmd，也就相当于Controller ###

![在这里插入图片描述][0384bc03de8042efbf2063a5e75071eb.png]

想要看到返回值就使用context调用一下setResponseEntity方法设置一下值，否则就只能看到接口调用成功的信息。

![在这里插入图片描述][0a1b977ef9274c66bc8b48f757cb808a.png]

我这里只是想看看接口调用的结果，就简单返回个字符串，更多详情可以看其他xxxCmd类。

注意：

> Java110Cmd注解中的 serviceCode 的值后面要使用dev账号注册服务。

## 三、使用Java110Cmd注解的值注册服务 ##

### 1、先使用dev账号登录 ###

![在这里插入图片描述][551d4c9ef6a2440f993eab2457791994.png]

### 2、在“服务–服务注册–服务绑定”进行服务绑定 ###

![在这里插入图片描述][e45d851fe5a74d78a7373a7b974cd343.png]

#### （1）、选择应用 ####

真正开发接口的时候选择对应应用就行了，我这里选择的是小区管理系统 web 端

![在这里插入图片描述][050bf0f6b23a4610bbec940f73ce6131.png]

![在这里插入图片描述][69783e0b8ba84a91964809694ff17d2c.png]

#### （2）、选择/添加服务 ####

一般都是先添加服务后再选择  
![在这里插入图片描述][7b1ec39e1b1645dfbffac12db3ec8c60.png]

![在这里插入图片描述][39523021aa6c4813b00156d08cc82c04.png]  
注意！！！

> 这个服务编码就是@Java110Cmd对应的值，千万不要写错了，写错了后面调用接口会报错。

我这里添加过了，就不再做添加，点击选择服务进行选择就行了

![在这里插入图片描述][0dcfe40735b74b558185219139e0decc.png]

添加成功之后可能在选择服务时看不到，选择“缓存–刷新缓存”，清一下对应缓存

![在这里插入图片描述][f47a456885b546118733438a2fba1e75.png]

没有意外的话就可以在选择服务那看到了。

================================================================================================

如果看不到的话可以去“tt”数据库中的“c\_service”，使用Java110Cmd注解的值（服务编码）查一下有没有对应的记录，没有的话应该就是添加时服务编码写错了

![在这里插入图片描述][d812247ce87041b59fc7c91aad1213ed.png]

## 四、调用接口 ##

### 1、在postman中调用 ###

![在这里插入图片描述][4942c43163554c50b5545bce15606c47.png]

![在这里插入图片描述][6e5f809fa94c4eb2994b78918509654b.png]

### 2、在项目中调用 ###

我这里是测试，就随便找地方加个按钮进行接口调用，先看看效果

![在这里插入图片描述][945a9156c5784e17b86cb00840ed2d6b.png]

源码如下：

![在这里插入图片描述][3af7286134434e83bd3d2709ff88d3b1.png]

_testGet: function() {
        
        var param = {
        
            params: {
        
                page: 1,
                row: 100,
                shType: '2806',
                communityId: vc.getCurrentCommunity().communityId
            }
        };
        //发送get请求
        vc.http.apiGet('test.testMethod',
            param,
            function (json, res) {
        
                let _storehouseManageInfo = JSON.parse(json);
                vc.component.addResourceStoreInfo.storehouses = _storehouseManageInfo.data;
    
            }, function (errInfo, error) {
        
                console.log('请求失败处理');
            }
        );
    },

从其他地方拿到vc.http.apiGet方法，将第一个参数值改为我的@Java110Cmd注解（服务编码）的值，其他都没有改，会自动生成当前时间以及TRANSACTION-ID

![在这里插入图片描述][e8641271c2804158b0d44e1f068d6ace.png]

## 五、踩坑记录 ##

### 1、可以在服务注册哪里看到绑定的服务信息，但调用接口的时候进不去方法里，打断点也不会停下 ###

检查一下自己新建的服务接口、Cmd接口的所处包位置，如果是建在已经存在的包里，那应该没有问题，如果是放在自己新建的包里，那么可能是没有扫描到包，在对应的ApplicationStart添加扫描包

![在这里插入图片描述][5eccde3607484958ac6e43973d5e4679.png]

添加之后重启对应的ApplicationStart服务。

[3e6a6059f5274b12b78c17f274b1bfb2.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/84b2cb58fc954ed3a6af784ef95ce6f5.png
[68cd8625aeca4018a2b660c5b99a9879.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/f4fe7719a58341cf8aed2d6fe99c3be4.png
[d3ffbf0105ee4a5a987cc167f7e56339.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/193470938d694c6e9eace5cfd9bcb676.png
[0384bc03de8042efbf2063a5e75071eb.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/d2f5e3e4cd4f4839bca9eb41bf594cca.png
[0a1b977ef9274c66bc8b48f757cb808a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/22ffc0394c964411adc16fba419fa6ae.png
[551d4c9ef6a2440f993eab2457791994.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/6340977fcd5a4231adaf53e21c7ede9b.png
[e45d851fe5a74d78a7373a7b974cd343.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/e362f834605d49f8b1328f4d9d464d61.png
[050bf0f6b23a4610bbec940f73ce6131.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/801d18073dac4896a4a74640a07bbe2b.png
[69783e0b8ba84a91964809694ff17d2c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/76c9c904d50644598e791c8732cbf2e5.png
[7b1ec39e1b1645dfbffac12db3ec8c60.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/49331e7d288f429596fe52da11651c50.png
[39523021aa6c4813b00156d08cc82c04.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/ac30bf5128a64cdabc87f75564ade5ac.png
[0dcfe40735b74b558185219139e0decc.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/1b361d01f84c4c23b1b13de0d5cdc60d.png
[f47a456885b546118733438a2fba1e75.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/fc9b8e6440c84923bff36edb5ed95488.png
[d812247ce87041b59fc7c91aad1213ed.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/732cb866eed545d28cf5217a27c17543.png
[4942c43163554c50b5545bce15606c47.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/4a4731d0f5f542faa89ddd6d6f7a5a0d.png
[6e5f809fa94c4eb2994b78918509654b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/f5c48e6a809249309e5d71d290d02100.png
[945a9156c5784e17b86cb00840ed2d6b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/d99a8e04c38349b39f721a7b83a3bcff.png
[3af7286134434e83bd3d2709ff88d3b1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/05b84cf9d37f44faa913ba38da0a0a99.png
[e8641271c2804158b0d44e1f068d6ace.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/6e5e661d5535452995327a68d8f692a0.png
[5eccde3607484958ac6e43973d5e4679.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/b4581ccd6a0a4e048b5cf6bc24ecab9e.png