大家好,又见面了,我是你们的朋友全栈君。
本文分三部分系统介绍如何开发一套在线客服系统聊天源码,该源码基于ThinkPHP,代码完全开源。
首先,我们只使用@auth指令。
其次,我们添加一个带有参数的订阅类型。
第三,我们更新@auth指令和订阅类型。
完整源码:kf.zxkfym.top
1 使用@auth指令并执行身份验证
添加和使用身份验证
$ amplify add auth
Scanning for plugins...
Plugin scan successful
Using service: Cognito, provided by: awscloudformation
The current configured provider is Amazon Cognito.
Do you want to use the default authentication and security configuration? Default configuration
Warning: you will not be able to edit these selections.
How do you want users to be able to sign in? Username
Do you want to configure advanced settings? No, I am done.
Successfully added auth resource sampleamplifysubscriXXXXXXXX locally
Some next steps:
"amplify push" will build all your local backend resources and provision it in the cloud
"amplify publish" will build all your local backend and frontend resources (if you have hosting category added) and provision it in the cloud
$
$ amplify push
✔ Successfully pulled backend environment dev from the cloud.
Current Environment: dev
| Category | Resource name | Operation | Provider plugin |
| -------- | ---------------------------- | --------- | ----------------- |
| Auth | sampleamplifysubscriXXXXXXXX | Create | awscloudformation |
| Api | sampleamplifysubscri | No Change | awscloudformation |
? Are you sure you want to continue? Yes
⠙ Updating resources in the cloud. This may take a few minutes...
(snip)
✔ All resources are updated in the cloud
$
然后,更新 api。
$ amplify update api
? Please select from one of the below mentioned services: GraphQL
? Select from the options below Update auth settings
? Choose the default authorization type for the API Amazon Cognito User Pool
Use a Cognito user pool configured as a part of this project.
? Configure additional auth types? No
The following types do not have '@auth' enabled. Consider using @auth with @model
- OpenChat
- RoomChat
Learn more about @auth here: https://docs.amplify.aws/cli/graphql-transformer/auth
GraphQL schema compiled successfully.
Edit your schema at /[YOUR_DIRECTORY]/sample-amplify-subscriptions/amplify/backend/api/sampleamplifysubscri/schema.graphql or place .graphql files in a directory at /[YOUR_DIRECTORY]/sample-amplify-subscriptions/amplify/backend/api/sampleamplifysubscri/schema
The API_KEY auth type has been removed from the API.
If other resources depend on this API, run "amplify update <category>" and reselect this API to remove the dependency on the API key.
⚠️ This must be done before running "amplify push" to prevent a push failure
Successfully updated resource
$
这意味着,我们可以使用@auth指令并且只能使用userPools.
更新 graphql 模式文件。
type CloseRoomChat
@model
@auth(rules: [{ allow: owner, provider: userPools }]) {
id: ID!
roomName: String!
message: String!
}
$ amplify push
✔ Successfully pulled backend environment dev from the cloud.
Current Environment: dev
| Category | Resource name | Operation | Provider plugin |
| -------- | ---------------------------- | --------- | ----------------- |
| Api | sampleamplifysubscri | Update | awscloudformation |
| Auth | sampleamplifysubscriXXXXXXXX | No Change | awscloudformation |
? Are you sure you want to continue? Yes
The following types do not have '@auth' enabled. Consider using @auth with @model
- OpenChat
- RoomChat
Learn more about @auth here: https://docs.amplify.aws/cli/graphql-transformer/auth
GraphQL schema compiled successfully.
Edit your schema at /[YOUR_DIRECTORY]/sample-amplify-subscriptions/amplify/backend/api/sampleamplifysubscri/schema.graphql or place .graphql files in a directory at /[YOUR_DIRECTORY]/sample-amplify-subscriptions/amplify/backend/api/sampleamplifysubscri/schema
? Do you want to update code for your updated GraphQL API Yes
? Do you want to generate GraphQL statements (queries, mutations and subscription) based on your schema types?
This will overwrite your current graphql queries, mutations and subscriptions Yes
⠴ Updating resources in the cloud. This may take a few minutes...
(snip)
✔ Generated GraphQL operations successfully and saved at src/graphql
✔ All resources are updated in the cloud
GraphQL endpoint: https://XXXXXXXXXXXXXXXXXXXXXXXXXX.appsync-api.ap-northeast-1.amazonaws.com/graphql
$
实现登录页面。
实施封闭式聊天页面。
<template>
<v-container>
<v-row>
<v-col cols="12">
<v-card>
<v-card-title>Multi-room Close Chat</v-card-title>
<v-card-text
>Only authenticated users can use this chat. All subscriptions are
received.
</v-card-text>
</v-card>
</v-col>
</v-row>
<v-row>
<v-col cols="12">
<v-text-field
v-model="inputMessage"
label="New Message"
outlined
clearable
append-outer-icon="mdi-send"
@click:append-outer="sendMessage"
></v-text-field>
</v-col>
</v-row>
<v-tabs
v-model="roomName"
background-color="primary"
center-active
centered
dark
>
<v-tab
v-for="(room, index) in rooms"
:key="index"
:href="'#' + room"
@click="setSubscribeByRoomName(room)"
>{
{ room }}</v-tab
>
</v-tabs>
<v-card flat>
<v-tabs-items v-model="roomName">
<v-tab-item v-for="(room, index) in rooms" :key="index" :value="room">
<v-row class="pa-2">
<v-col cols="6">
<ChatList title="Input" :list="messages[room]"></ChatList>
</v-col>
<v-col cols="6">
<ChatList
title="Subscriptions"
:list="subscriptionMessages[room]"
></ChatList>
</v-col>
</v-row>
</v-tab-item>
</v-tabs-items>
</v-card>
</v-container>
</template>
<script>
import { Auth, API, graphqlOperation } from 'aws-amplify'
import { createCloseRoomChat } from '@/graphql/mutations'
import { onCreateCloseRoomChat } from '@/graphql/subscriptions'
import ChatList from '@/components/ChatList'
export default {
components: { ChatList },
data: function() {
return {
user: null,
roomName: null,
inputMessage: '',
rooms: ['room1', 'room2'],
messages: {
room1: [],
room2: [],
},
subscriptionMessages: {
room1: [],
room2: [],
},
onCreateMultiRoomChatSubscriptions: {
room1: null,
room2: null,
},
}
},
created: async function() {
this.user = await Auth.currentUserInfo()
this.setSubscribeByRoomName('room1')
},
beforeDestroy: function() {
this.clearSubscriptions()
},
methods: {
sendMessage: async function() {
const message = await API.graphql(
graphqlOperation(createCloseRoomChat, {
input: { message: this.inputMessage, roomName: this.roomName },
}),
)
console.log(message)
this.messages[this.roomName].push(message.data.createCloseRoomChat)
this.inputMessage = ''
},
setSubscribeByRoomName(roomName) {
this.clearSubscriptions()
this.onCreateMultiRoomChatSubscriptions[roomName] = API.graphql(
graphqlOperation(onCreateCloseRoomChat, { owner: this.user.username }),
).subscribe({
next: ({ provider, value }) => {
console.log({ provider, value })
this.subscriptionMessages[
value.data.onCreateCloseRoomChat.roomName
].push(value.data.onCreateCloseRoomChat)
},
})
},
clearSubscriptions() {
this.rooms.forEach(room => {
if (this.onCreateMultiRoomChatSubscriptions[room]) {
this.onCreateMultiRoomChatSubscriptions[room].unsubscribe()
}
this.onCreateMultiRoomChatSubscriptions[room] = null
})
},
},
}
</script>
<style></style>
重要的一点就在这里。
(snip)
import { Auth, API, graphqlOperation } from 'aws-amplify'
import { createCloseRoomChat } from '@/graphql/mutations'
import { onCreateCloseRoomChat } from '@/graphql/subscriptions'
(snip)
created: async function() {
this.user = await Auth.currentUserInfo()
this.setSubscribeByRoomName('room1')
},
(snip)
sendMessage: async function() {
const message = await API.graphql(
graphqlOperation(createCloseRoomChat, {
...
this.messages[this.roomName].push(message.data.createCloseRoomChat)
...
(snip)
setSubscribeByRoomName(roomName) {
this.clearSubscriptions()
this.onCreateMultiRoomChatSubscriptions[roomName] = API.graphql(
graphqlOperation(onCreateCloseRoomChat, { owner: this.user.username }),
...
this.subscriptionMessages[
value.data.onCreateCloseRoomChat.roomName
].push(value.data.onCreateCloseRoomChat)
...
(snip)
createCloseRoomChat使用与createRoomChat
onCreateCloseRoomChat使用而不是onCreateRoomChat
并且,onCreateCloseRoomChat需要有论据owner。
owner信息是这样得到的。
this.user = await Auth.currentUserInfo()
this.user.username // your sign-in username
无论如何,现在我们可以查看我们的第一个“在线客服系统”。
但是当你尝试这个时,你可能会有点失望。
您发布消息并接收自己的消息。
接下来,您打开另一个浏览器,登录另一个用户,打开“客服系统”,然后发布消息。
您无法在原始浏览器上收到另一条消息。
2 添加带参数的订阅类型
更新 graphql 架构
因此,我们添加了一个 Subscription 类型,其参数roomName类似于onCreateRoomChatByRoomName上一篇文章中添加的参数。
更新 graphql 模式文件。
type Subscription {
onCreateRoomChatByRoomName(roomName: String!): RoomChat
@aws_subscribe(mutations: ["createRoomChat"])
onCreateCloseRoomChatByRoomName(roomName: String!): CloseRoomChat
@aws_subscribe(mutations: ["createCloseRoomChat"])
}
$ amplify push
✔ Successfully pulled backend environment dev from the cloud.
Current Environment: dev
| Category | Resource name | Operation | Provider plugin |
| -------- | ---------------------------- | --------- | ----------------- |
| Api | sampleamplifysubscri | Update | awscloudformation |
| Auth | sampleamplifysubscriXXXXXXXX | No Change | awscloudformation |
? Are you sure you want to continue? Yes
The following types do not have '@auth' enabled. Consider using @auth with @model
- OpenChat
- RoomChat
Learn more about @auth here: https://docs.amplify.aws/cli/graphql-transformer/auth
GraphQL schema compiled successfully.
Edit your schema at /[YOUR_DIRECTORY]/sample-amplify-subscriptions/amplify/backend/api/sampleamplifysubscri/schema.graphql or place .graphql files in a directory at /[YOUR_DIRECTORY]/sample-amplify-subscriptions/amplify/backend/api/sampleamplifysubscri/schema
? Do you want to update code for your updated GraphQL API Yes
? Do you want to generate GraphQL statements (queries, mutations and subscription) based on your schema types?
This will overwrite your current graphql queries, mutations and subscriptions Yes
⠴ Updating resources in the cloud. This may take a few minutes...
(snip)
✔ All resources are updated in the cloud
GraphQL endpoint: https://XXXXXXXXXXXXXXXXXXXXXXXXXX.appsync-api.ap-northeast-1.amazonaws.com/graphql
$
更新封闭聊天
<template>
<v-container>
<v-row>
<v-col cols="12">
<v-card>
<v-card-title>Multi-room Close Chat</v-card-title>
<v-card-text
>Only authenticated users can use this chat. All subscriptions are
received.
</v-card-text>
</v-card>
</v-col>
</v-row>
<v-row>
<v-col cols="12">
<v-text-field
v-model="inputMessage"
label="New Message"
outlined
clearable
append-outer-icon="mdi-send"
@click:append-outer="sendMessage"
></v-text-field>
</v-col>
</v-row>
<v-tabs
v-model="roomName"
background-color="primary"
center-active
centered
dark
>
<v-tab
v-for="(room, index) in rooms"
:key="index"
:href="'#' + room"
@click="setSubscribeByRoomName(room)"
>{
{ room }}</v-tab
>
</v-tabs>
<v-card flat>
<v-tabs-items v-model="roomName">
<v-tab-item v-for="(room, index) in rooms" :key="index" :value="room">
<v-row class="pa-2">
<v-col cols="6">
<ChatList title="Input" :list="messages[room]"></ChatList>
</v-col>
<v-col cols="6">
<ChatList
title="Subscriptions"
:list="subscriptionMessages[room]"
></ChatList>
</v-col>
</v-row>
</v-tab-item>
</v-tabs-items>
</v-card>
</v-container>
</template>
<script>
import { Auth, API, graphqlOperation } from 'aws-amplify'
import { createCloseRoomChat } from '@/graphql/mutations'
import { onCreateCloseRoomChatByRoomName } from '@/graphql/subscriptions'
import ChatList from '@/components/ChatList'
export default {
components: { ChatList },
data: function() {
return {
user: null,
roomName: null,
inputMessage: '',
rooms: ['room1', 'room2'],
messages: {
room1: [],
room2: [],
},
subscriptionMessages: {
room1: [],
room2: [],
},
onCreateMultiRoomChatSubscriptions: {
room1: null,
room2: null,
},
}
},
created: async function() {
this.user = await Auth.currentUserInfo()
this.setSubscribeByRoomName('room1')
},
beforeDestroy: function() {
this.clearSubscriptions()
},
methods: {
sendMessage: async function() {
const message = await API.graphql(
graphqlOperation(createCloseRoomChat, {
input: { message: this.inputMessage, roomName: this.roomName },
}),
)
console.log(message)
this.messages[this.roomName].push(message.data.createCloseRoomChat)
this.inputMessage = ''
},
setSubscribeByRoomName(roomName) {
this.clearSubscriptions()
this.onCreateMultiRoomChatSubscriptions[roomName] = API.graphql(
graphqlOperation(onCreateCloseRoomChatByRoomName, {
roomName: roomName,
}),
).subscribe({
next: ({ provider, value }) => {
console.log({ provider, value })
this.subscriptionMessages[
value.data.onCreateCloseRoomChatByRoomName.roomName
].push(value.data.onCreateCloseRoomChatByRoomName)
},
})
},
clearSubscriptions() {
this.rooms.forEach(room => {
if (this.onCreateMultiRoomChatSubscriptions[room]) {
this.onCreateMultiRoomChatSubscriptions[room].unsubscribe()
}
this.onCreateMultiRoomChatSubscriptions[room] = null
})
},
},
}
</script>
<style></style>
并且,onCreateRoomChatByRoomName需要有论据roomName。
你试试这个程序,你可以收到另一个用户的消息。
这意味着,“只有授权用户才能发布使用在线客服系统。”
3、但是,我们经常使用“授权用户可以发布但所有用户都可以阅读”的系统。
所以,我们做到了。
更新多授权api
以前,我们只使用Amazon Cognito User Pool.
在这里,我们使用Amazon Cognito User Pool和API key。
$ amplify update api
? Please select from one of the below mentioned services: GraphQL
? Select from the options below Update auth settings
? Choose the default authorization type for the API Amazon Cognito User Pool
Use a Cognito user pool configured as a part of this project.
? Configure additional auth types? Yes
? Choose the additional authorization types you want to configure for the API API key
API key configuration
? Enter a description for the API key:
? After how many days from now the API key should expire (1-365): 365
The following types do not have '@auth' enabled. Consider using @auth with @model
- OpenChat
- RoomChat
Learn more about @auth here: https://docs.amplify.aws/cli/graphql-transformer/auth
GraphQL schema compiled successfully.
Edit your schema at /[YOUR_DIRECTORY]/sample-amplify-subscriptions/amplify/backend/api/sampleamplifysubscri/schema.graphql or place .graphql files in a directory at /[YOUR_DIRECTORY]/sample-amplify-subscriptions/amplify/backend/api/sampleamplifysubscri/schema
The API_KEY auth type has been added to the API.
⚠️ If other resources depend on this API and need access to the API key, run "amplify update <category>" and reselect this API as a dependency to add the API key dependency.
Successfully updated resource
$
然后,更新 graphql 模式文件。
更新@auth指令和订阅:
type CloseRoomChat
@model
@auth(
rules: [
{ allow: owner, provider: userPools }
{ allow: public, provider: apiKey, operations: [read] }
]
) {
id: ID!
roomName: String!
message: String!
}
type Subscription {
onCreateRoomChatByRoomName(roomName: String!): RoomChat
@aws_subscribe(mutations: ["createRoomChat"])
onCreateCloseRoomChatByRoomName(roomName: String!): CloseRoomChat
@aws_subscribe(mutations: ["createCloseRoomChat"])
@aws_api_key
}
注意:
@aws_api_key不在“放大文档”中。
$ amplify push
✔ Successfully pulled backend environment dev from the cloud.
Current Environment: dev
| Category | Resource name | Operation | Provider plugin |
| -------- | ---------------------------- | --------- | ----------------- |
| Api | sampleamplifysubscri | Update | awscloudformation |
| Auth | sampleamplifysubscriXXXXXXXX | No Change | awscloudformation |
? Are you sure you want to continue? Yes
The following types do not have '@auth' enabled. Consider using @auth with @model
- OpenChat
- RoomChat
Learn more about @auth here: https://docs.amplify.aws/cli/graphql-transformer/auth
GraphQL schema compiled successfully.
Edit your schema at /[YOUR_DIRECTORY]/sample-amplify-subscriptions/amplify/backend/api/sampleamplifysubscri/schema.graphql or place .graphql files in a directory at /[YOUR_DIRECTORY]/sample-amplify-subscriptions/amplify/backend/api/sampleamplifysubscri/schema
? Do you want to update code for your updated GraphQL API Yes
? Do you want to generate GraphQL statements (queries, mutations and subscription) based on your schema types?
This will overwrite your current graphql queries, mutations and subscriptions Yes
⠧ Updating resources in the cloud. This may take a few minutes...
(snip)
✔ All resources are updated in the cloud
GraphQL endpoint: https://XXXXXXXXXXXXXXXXXXXXXXXXXX.appsync-api.ap-northeast-1.amazonaws.com/graphql
GraphQL API KEY: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
$
最后,我们得到了“授权用户可以发帖,所有用户都可以使用在线客服聊天系统。
您打开浏览器并打开“封闭聊天”(使用非授权用户)。
然后,您打开另一个浏览器,登录另一个用户,打开“客服系统”,然后发布消息。
您可以在原始浏览器上接收消息!
发布者:全栈程序员-用户IM,转载请注明出处:https://javaforall.cn/161832.html原文链接:https://javaforall.cn
【正版授权,激活自己账号】: Jetbrains全家桶Ide使用,1年售后保障,每天仅需1毛
【官方授权 正版激活】: 官方授权 正版激活 支持Jetbrains家族下所有IDE 使用个人JB账号...