添加注释

Author: Sen

haoke-im/src/main/java/com/sen/haoke/im/controller/MessageController.java

@@ -13,7 +13,7 @@
 /**
  * @Auther: Sen
  * @Date: 2020/2/17 23:08
- * @Description:
+ * @Description: 微聊控制中心
  */
 @RestController
 @RequestMapping("message")

haoke-im/src/main/java/com/sen/haoke/im/pojo/Message.java

@@ -27,7 +27,7 @@
 public class Message {
 
     @Id
-    //指定次属性使用JackSon序列化称字符串
+    //指定属性使用JackSon序列化称字符串
     @JsonSerialize(using = ToStringSerializer.class)
     private ObjectId id;
 

haoke-im/src/main/java/com/sen/haoke/im/websocket/MyHandler.java

@@ -90,7 +90,7 @@ public void handleMessage(WebSocketSession session, WebSocketMessage<?> message)
             //把MongoDB的消息状态更新为已读
             messageDao.updateMessageStatus(target.getId(), 2);
         }else{
-            //当前的额Session不在当前JVM或者Session不在线,发送消息到MQ
+            //当前的Session不在当前JVM或者Session不在线,发送消息到MQ
             rocketMQTemplate.convertAndSend("haoke-im-send-message:SEND_MSG", msgJson);
         }
     }
@@ -103,6 +103,10 @@ public void afterConnectionClosed(WebSocketSession session, CloseStatus status)
         LONG_WEB_SOCKET_SESSION_MAP.remove(uid);
     }
 
+    /**
+     * RocketMQ接收消息接口实现
+     * @param message RocketMQ消息
+     */
     @Override
     public void onMessage(String message) {
         //获取uid

haoke-im/src/main/java/com/sen/haoke/im/websocket/WebSocketConfiguration.java

@@ -4,7 +4,6 @@
 import org.springframework.web.socket.config.annotation.EnableWebSocket;
 import org.springframework.web.socket.config.annotation.WebSocketConfigurer;
 import org.springframework.web.socket.config.annotation.WebSocketHandlerRegistry;
-
 import javax.annotation.Resource;
 
 /**
@@ -24,8 +23,11 @@ public class WebSocketConfiguration implements WebSocketConfigurer {
 
     @Override
     public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
+        //配置websocket路径和参数
         registry.addHandler(myHandler, "/ws/{uid}")
+                //配置跨域
                 .setAllowedOrigins("*")
+                //配置拦截器
                 .addInterceptors(webSocketInterceptor);
     }
 }

haoke-manage-web/src/pages/haoke/House/Resource.js

@@ -27,12 +27,13 @@ const getValue = obj =>
     .join(',');
 //支付方式
 const payType = new Map([
-  [1,'付一押一'],
-  [2,'付三押一'],
-  [3,'付六押一'],
-  [4,'年付押一'],
-  [5,'其它'],
+  [1, '付一押一'],
+  [2, '付三押一'],
+  [3, '付六押一'],
+  [4, '年付押一'],
+  [5, '其它'],
 ]);
+
 /* eslint react/no-multi-comp:0 */
 @connect(({houseResource, loading}) => ({
   houseResource,
@@ -61,7 +62,7 @@ class Resource extends PureComponent {
     {
       title: '图',
       dataIndex: 'pic',
-      render : (text, record, index) => {
+      render: (text, record, index) => {
         return <ShowPics pics={text}/>
       }
 
@@ -106,8 +107,9 @@ class Resource extends PureComponent {
       ),
     }
   ];
-  reload(){
-    const { dispatch } = this.props;
+
+  reload() {
+    const {dispatch} = this.props;
     dispatch({
       type: 'houseResource/fetch'
     });

haoke-manage/haoke-manage-api/src/main/java/com/sen/haoke/manage/api/config/InterceptorConfig.java

@@ -17,7 +17,7 @@ public class InterceptorConfig implements WebMvcConfigurer {
     private RedisInterceptor redisInterceptor;
 
     /**
-     * 注册自定义拦截器到Spring拦截器链中
+     * 注册自定义{@link RedisInterceptor}拦截器到Spring拦截器链中
      * @param registry
      */
     @Override

haoke-manage/haoke-manage-api/src/main/java/com/sen/haoke/manage/api/config/MockConfiguration.java

@@ -8,7 +8,7 @@
 /**
  * @Auther: Sen
  * @Date: 2020/2/13 21:45
- * @Description:
+ * @Description: @PropertySource注解实现配置文件与{@link MockConfiguration}属性的自动映射
  */
 @Configuration
 @PropertySource("classpath:mock-data.properties")

haoke-manage/haoke-manage-api/src/main/java/com/sen/haoke/manage/api/controller/HouseResourcesController.java

@@ -5,16 +5,13 @@
 import com.sen.haoke.manage.dubbo.server.pojo.HouseResources;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
-import org.springframework.stereotype.Controller;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PostMapping;
 import org.springframework.web.bind.annotation.PutMapping;
 import org.springframework.web.bind.annotation.RequestBody;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RequestParam;
-import org.springframework.web.bind.annotation.ResponseBody;
 import org.springframework.web.bind.annotation.RestController;
-
 import javax.annotation.Resource;
 
 /**

haoke-manage/haoke-manage-api/src/main/java/com/sen/haoke/manage/api/controller/MockController.java

@@ -10,7 +10,7 @@
 /**
  * @Auther: Sen
  * @Date: 2020/2/13 21:48
- * @Description:
+ * @Description: 服务端提供mock数据给客户端
  */
 @RestController
 @CrossOrigin

haoke-manage/haoke-manage-api/src/main/java/com/sen/haoke/manage/api/controller/PicUploadController.java

@@ -2,14 +2,12 @@
 
 import com.sen.haoke.manage.api.service.PicUploadService;
 import com.sen.haoke.manage.api.vo.UploadParams;
-import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.stereotype.Controller;
 import org.springframework.web.bind.annotation.PostMapping;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RequestParam;
 import org.springframework.web.bind.annotation.ResponseBody;
 import org.springframework.web.multipart.MultipartFile;
-
 import javax.annotation.Resource;
 
 /**

haoke-manage/haoke-manage-api/src/main/java/com/sen/haoke/manage/api/controller/WxController.java

@@ -16,7 +16,7 @@
 /**
  * @Auther: Sen
  * @Date: 2020/2/25 21:19
- * @Description:
+ * @Description: 实现微信登录
  */
 @RestController
 @RequestMapping("wx")

haoke-manage/haoke-manage-api/src/main/java/com/sen/haoke/manage/api/graphql/GraphQLProvider.java

@@ -26,43 +26,49 @@
 /**
  * @Auther: Sen
  * @Date: 2020/2/11 22:59
- * @Description:
+ * @Description: 初始化GraphQL对象并注入Spring IOC容器中
  */
 @Component
 public class GraphQLProvider {
 
     private GraphQL graphQL;
 
-   @Resource
-   private List<MyDataFetcher> myDataFetchers;
+    /**
+     * spring注入所有MyDataFetcher的实现类到集合中
+     */
+    @Resource
+    private List<MyDataFetcher> myDataFetchers;
 
     /**
      * Spring初始化后初始化GraphQL对象
      */
     @PostConstruct
     public void init() {
         //初始化graphql文件
-        File file = null;
+        //File file = null;
         try {
+            //读取GraphQL文件
             InputStream resource = GraphQLProvider.class.getClassLoader().getResourceAsStream("haoke.graphql");
             // file = ResourceUtils.getFile("classpath:haoke.graphql");
             String graphqlStr = IOUtils.toString(Objects.requireNonNull(resource), StandardCharsets.UTF_8);
             TypeDefinitionRegistry typeRegistry = new SchemaParser().parse(graphqlStr);
-            //查询
+
+            //确定与GraphQL文件操作返回值对象映射
             RuntimeWiring wiring = RuntimeWiring.newRuntimeWiring()
-                    .type("HaokeQuery", builder->
+                    .type("HaokeQuery", builder ->
                             {
                                 myDataFetchers.forEach(myDataFetcher -> {
                                     builder.dataFetcher(myDataFetcher.fileName(), myDataFetcher::dataFetcher);
                                 });
                                 return builder;
                             }
-                        //     builder.dataFetcher("HouseResources", param->{
-                        //     Long id = param.getArgument("id");
-                        //     return service.queryHouseResources(id);
-                        // })
+                            //     builder.dataFetcher("HouseResources", param->{
+                            //     Long id = param.getArgument("id");
+                            //     return service.queryHouseResources(id);
+                            // })
                     )
                     .build();
+            //创建Schema
             GraphQLSchema graphQLSchema = new SchemaGenerator().makeExecutableSchema(typeRegistry, wiring);
             this.graphQL = GraphQL.newGraphQL(graphQLSchema).build();
         } catch (IOException e) {
@@ -72,10 +78,11 @@ public void init() {
 
     /**
      * 把graphQL交给Spring容器托管
+     *
      * @return
      */
     @Bean
-    public GraphQL graphQL(){
+    public GraphQL graphQL() {
         return this.graphQL;
     }
 }

haoke-manage/haoke-manage-api/src/main/java/com/sen/haoke/manage/api/graphql/MyDataFetcher.java

@@ -11,7 +11,16 @@
 @Component
 public interface MyDataFetcher {
 
+    /**
+     * 获取GraphQL操作名
+     * @return String
+     */
     String fileName();
 
+    /**
+     * 返回结果映射封装对象返回
+     * @param environment 查询参数
+     * @return 查询结果
+     */
     Object dataFetcher(DataFetchingEnvironment environment);
 }

haoke-manage/haoke-manage-api/src/main/java/com/sen/haoke/manage/api/interceptor/MyResponseBodyAdvice.java

@@ -36,10 +36,11 @@ public class MyResponseBodyAdvice implements ResponseBodyAdvice {
      *
      * @param returnType
      * @param converterType
-     * @return 返回true执行 beforeBodyWrite()
+     * @return 返回true执行 beforeBodyWrite() 实现增强
      */
     @Override
     public boolean supports(MethodParameter returnType, Class converterType) {
+        // Controller中get请求结果全部缓存
         if (returnType.hasMethodAnnotation(GetMapping.class)) {
             return true;
         }

haoke-manage/haoke-manage-api/src/main/java/com/sen/haoke/manage/api/interceptor/MyServletRequestWrapper.java

@@ -2,10 +2,8 @@
 
 
 import org.apache.commons.io.IOUtils;
-
 import javax.servlet.ReadListener;
 import javax.servlet.ServletInputStream;
-
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletRequestWrapper;
 import java.io.BufferedReader;

haoke-manage/haoke-manage-api/src/main/java/com/sen/haoke/manage/api/interceptor/RedisInterceptor.java

@@ -17,7 +17,7 @@
 /**
  * @Auther: Sen
  * @Date: 2020/2/14 22:59
- * @Description:
+ * @Description: 查询缓存拦截器
  */
 @Component
 public class RedisInterceptor implements HandlerInterceptor {
@@ -53,6 +53,7 @@ public boolean preHandle(HttpServletRequest request, HttpServletResponse respons
         response.setHeader("Access-Control-Allow-Credentials", "true");
         response.setHeader("Access-Control-Allow-Headers", "Content-Type,X-Token");
         response.setHeader("Access-Control-Allow-Credentials", "true");
+        //缓存内容放入Response中
         response.getWriter().write(result);
         return false;
     }

haoke-manage/haoke-manage-api/src/main/java/com/sen/haoke/manage/api/interceptor/RequestReplaceFilter.java

@@ -12,6 +12,7 @@
  * @Auther: Sen
  * @Date: 2020/2/15 00:18
  * @Description: 替换Request为包装后的Request
+ * {@link OncePerRequestFilter}一个请求，该类只会拦截一次
  */
 @Component
 public class RequestReplaceFilter  extends OncePerRequestFilter {

haoke-manage/haoke-manage-api/src/main/java/com/sen/haoke/manage/api/service/MongoDBHouseService.java

@@ -8,7 +8,6 @@
 import org.springframework.data.mongodb.core.query.Criteria;
 import org.springframework.data.mongodb.core.query.Query;
 import org.springframework.stereotype.Service;
-
 import javax.annotation.Resource;
 import java.util.ArrayList;
 import java.util.HashMap;
@@ -18,7 +17,7 @@
 /**
  * @Auther: Sen
  * @Date: 2020/2/22 01:25
- * @Description:
+ * @Description: MongDB实现地图找房
  */
 @Service
 public class MongoDBHouseService {
@@ -57,7 +56,7 @@ public class MongoDBHouseService {
      * @param lng  经度
      * @param lat  纬度
      * @param zoom 缩放等级
-     * @return
+     * @return 搜索到的房源
      */
     public MapHouseDataResult queryHouseDataByMap(Float lng, Float lat, Integer zoom) {
         //默认查找范围是比例尺的1.5倍距离查找，除以111.12-->地球1°代表111.12km

haoke-manage/haoke-manage-api/src/main/java/com/sen/haoke/manage/api/service/PicUploadService.java

@@ -22,6 +22,7 @@
 public class PicUploadService {
     // 允许上传的格式
     private static final String[] IMAGE_TYPE = new String[]{".bmp", ".jpg", ".jpeg", ".gif", ".png"};
+
     @Resource
     private OSSClient ossClient;
 

haoke-manage/haoke-manage-api/src/main/java/com/sen/haoke/manage/api/service/SearchService.java

@@ -19,7 +19,6 @@
 import org.springframework.data.elasticsearch.core.query.NativeSearchQueryBuilder;
 import org.springframework.data.elasticsearch.core.query.SearchQuery;
 import org.springframework.stereotype.Service;
-
 import javax.annotation.Resource;
 import java.util.ArrayList;
 import java.util.Collections;
@@ -29,7 +28,7 @@
 /**
  * @Auther: Sen
  * @Date: 2020/2/28 15:38
- * @Description:
+ * @Description: ElasticSearch实现搜索功能
  */
 @Service
 public class SearchService {