diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..eaa54e6 --- /dev/null +++ b/.gitignore @@ -0,0 +1,17 @@ +# Binaries for programs and plugins +*.exe +*.exe~ +*.dll +*.so +*.dylib + +# Test binary, build with `go test -c` +*.test + +# Output of the go coverage tool, specifically when used with LiteIDE +*.out + +# macOS +.DS_Store +.idea +.vscode diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f49a4e1 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..c572d1d --- /dev/null +++ b/README.md @@ -0,0 +1,2 @@ +# ZhihuZhuanlanCrawler +知乎专栏爬虫 \ No newline at end of file diff --git a/client.go b/client.go new file mode 100644 index 0000000..9bcf098 --- /dev/null +++ b/client.go @@ -0,0 +1,48 @@ +package ZhihuZhuanlanCrawler + +import ( + "io/ioutil" + "net/http" +) + +type Client struct { + client *http.Client +} + +func NewClient(httpClient *http.Client) *Client { + if httpClient == nil { + httpClient = &http.Client{} + } + + c := &Client{ + client: httpClient, + } + + return c +} + +func (c *Client) SendNewZhihuRequest(u string) ([]byte, error) { + req, err := http.NewRequest("GET", u, nil) + if err != nil { + return nil, err + } + + defer req.Body.Close() + + req.Header.Add("Accept-Language", "zh-CN") + req.Header.Add("User-Agent", "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/71.0.3578.98 Safari/537.36") + req.Header.Add("Host", "zhuanlan.zhihu.com") + req.Header.Add("Referer", "https://zhuanlan.zhihu.com/") + + res, err := c.client.Do(req) + if err != nil { + return nil, err + } + + bodyByte, err := ioutil.ReadAll(res.Body) + if err != nil { + return nil, err + } + + return bodyByte, nil +} diff --git a/crawler.go b/crawler.go new file mode 100644 index 0000000..f0c2ac3 --- /dev/null +++ b/crawler.go @@ -0,0 +1,100 @@ +package ZhihuZhuanlanCrawler + +import ( + "encoding/json" + "errors" + "fmt" + "log" +) + +func (c *Client) GetPinnedArticlePidAndAuthor(columnName string) (*PinnedArticleAndAuthor, error) { + if columnName == "" { + return nil, errors.New(ColumnNameCanNotBeEmpty) + } + u := fmt.Sprintf("https://zhuanlan.zhihu.com/api2/columns/%s/pinned-article", columnName) + res, err := c.SendNewZhihuRequest(u) + if err != nil { + log.Println(err) + return nil, err + } + + pinnedArticleAndAuthor := PinnedArticleAndAuthor{} + err = json.Unmarshal(res, &pinnedArticleAndAuthor) + if err != nil { + log.Println(err) + return nil, err + } + + return &pinnedArticleAndAuthor, nil +} + +func (c *Client) GetSingleArticle(pid int) (*Article, error) { + if pid == 0 { + return nil, errors.New(PidCanNotBeEmpty) + } + u := fmt.Sprintf("https://zhuanlan.zhihu.com/api/posts/%d", pid) + res, err := c.SendNewZhihuRequest(u) + if err != nil { + log.Println(err) + return nil, err + } + + article := Article{} + err = json.Unmarshal(res, &article) + if err != nil { + log.Println(err) + return nil, err + } + + return &article, nil +} + +func (c *Client) GetArticlesListPids(columnName string) ([]int, error) { + if columnName == "" { + return nil, errors.New(ColumnNameCanNotBeEmpty) + } + + var limit = 20 + var offset = 0 + + u := fmt.Sprintf("https://zhuanlan.zhihu.com/api2/columns/%s/articles?limit=%d&offset=%d", columnName, limit, offset) + res, err := c.SendNewZhihuRequest(u) + if err != nil { + log.Println(err) + return nil, err + } + + articleList := ArticleList{} + err = json.Unmarshal(res, &articleList) + if err != nil { + log.Println(err) + return nil, err + } + + var articleIds = []int{} + + for _, entry := range articleList.Data { + articleIds = append(articleIds, entry.ID) + } + + for offset = offset + limit; offset < articleList.Paging.Totals; offset = offset + limit { + u := fmt.Sprintf("https://zhuanlan.zhihu.com/api2/columns/%s/articles?limit=%d&offset=%d", columnName, limit, offset) + res, err := c.SendNewZhihuRequest(u) + if err != nil { + log.Println(err) + return nil, err + } + + articleList := ArticleList{} + err = json.Unmarshal(res, &articleList) + if err != nil { + log.Println(err) + return nil, err + } + for _, entry := range articleList.Data { + articleIds = append(articleIds, entry.ID) + } + } + + return articleIds, nil +} diff --git a/error.go b/error.go new file mode 100644 index 0000000..3322671 --- /dev/null +++ b/error.go @@ -0,0 +1,6 @@ +package ZhihuZhuanlanCrawler + +const ( + ColumnNameCanNotBeEmpty = "专栏名不能为空" + PidCanNotBeEmpty = "pid 不能为空" +) \ No newline at end of file diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..49434c8 --- /dev/null +++ b/go.mod @@ -0,0 +1 @@ +module ZhihuZhuanlanCrawler diff --git a/httpclient.go b/httpclient.go new file mode 100644 index 0000000..ae22344 --- /dev/null +++ b/httpclient.go @@ -0,0 +1,70 @@ +package ZhihuZhuanlanCrawler + +import ( + "fmt" + "io" + "net/http" + "net/http/httputil" + "os" +) + +// DebugRequestTransport 会打印请求和响应信息, 方便调试. +type DebugRequestTransport struct { + RequestHeader bool + RequestBody bool // RequestHeader 为 true 时,这个选项才会生效 + ResponseHeader bool + ResponseBody bool // ResponseHeader 为 true 时,这个选项才会生效 + + // debug 信息输出到 Writer 中, 默认是 os.Stderr + Writer io.Writer + + Transport http.RoundTripper +} + +// RoundTrip implements the RoundTripper interface. +func (t *DebugRequestTransport) RoundTrip(req *http.Request) (*http.Response, error) { + req = cloneRequest(req) // per RoundTrip contract + w := t.Writer + if w == nil { + w = os.Stderr + } + + if t.RequestHeader { + a, _ := httputil.DumpRequestOut(req, t.RequestBody) + fmt.Fprintf(w, "%s\n\n", string(a)) + } + + resp, err := t.transport().RoundTrip(req) + if err != nil { + return resp, err + } + + if t.ResponseHeader { + + b, _ := httputil.DumpResponse(resp, t.ResponseBody) + fmt.Fprintf(w, "%s\n", string(b)) + } + + return resp, err +} + +func (t *DebugRequestTransport) transport() http.RoundTripper { + if t.Transport != nil { + return t.Transport + } + return http.DefaultTransport +} + +// cloneRequest returns a clone of the provided *http.Request. The clone is a +// shallow copy of the struct and its Header map. +func cloneRequest(r *http.Request) *http.Request { + // shallow copy of the struct + r2 := new(http.Request) + *r2 = *r + // deep copy of the Header + r2.Header = make(http.Header, len(r.Header)) + for k, s := range r.Header { + r2.Header[k] = append([]string(nil), s...) + } + return r2 +} diff --git a/httpclient_test.go b/httpclient_test.go new file mode 100644 index 0000000..3f8f5e2 --- /dev/null +++ b/httpclient_test.go @@ -0,0 +1,78 @@ +package ZhihuZhuanlanCrawler + +import ( + "bytes" + "net/http" + "net/http/httptest" + "strings" + "testing" +) + +var ( + // mux is the HTTP request multiplexer used with the test server. + mux *http.ServeMux + + // server is a test HTTP server used to provide mock API responses. + server *httptest.Server +) + +// setup sets up a test HTTP server along with a cos.Client that is +// configured to talk to that test server. Tests should register handlers on +// mux which provide mock responses for the API method being tested. +func setup() { + // test server + mux = http.NewServeMux() + server = httptest.NewServer(mux) +} + +// teardown closes the test HTTP server. +func teardown() { + server.Close() +} + +func TestDebugRequestTransport(t *testing.T) { + setup() + defer teardown() + + mux.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) { + w.Header().Add("X-Test-Response", "2333") + w.WriteHeader(http.StatusBadGateway) + w.Write([]byte("test response body")) + }) + + w := bytes.NewBufferString("") + client := http.Client{} + + client.Transport = &DebugRequestTransport{ + RequestHeader: true, + RequestBody: true, + ResponseHeader: true, + ResponseBody: true, + Writer: w, + } + + body := bytes.NewReader([]byte("test_request body")) + req, _ := http.NewRequest("GET", server.URL, body) + req.Header.Add("X-Test-Debug", "123") + client.Do(req) + + b := make([]byte, 800) + w.Read(b) + info := string(b) + if !strings.Contains(info, "GET / HTTP/1.1\r\n") || + !strings.Contains(info, "X-Test-Debug: 123\r\n") { + t.Errorf("DebugRequestTransport debug info %#v don't contains request header", info) + } + if !strings.Contains(info, "\r\n\r\ntest_request body") { + t.Errorf("DebugRequestTransport debug info %#v don't contains request body", info) + } + + if !strings.Contains(info, "HTTP/1.1 502 Bad Gateway\r\n") || + !strings.Contains(info, "X-Test-Response: 2333\r\n") { + t.Errorf("DebugRequestTransport debug info %#v don't contains response header", info) + } + + if !strings.Contains(info, "\r\n\r\ntest response body") { + t.Errorf("DebugRequestTransport debug info %#v don't contains response body", info) + } +} diff --git a/model.go b/model.go new file mode 100644 index 0000000..f5a00dd --- /dev/null +++ b/model.go @@ -0,0 +1,57 @@ +package ZhihuZhuanlanCrawler + +import "time" + +type Zhuanlan struct { + Slug string `json:"slug"` + Name string `json:"name"` +} + +type Author struct { + Id int `json:"id"` + Name string `json:"name"` + Gender int `json:"gender"` + Headline string `json:"headline"` + Description string `json:"description"` + AvatarUrl string `json:"avatar_url"` +} + +type PinnedArticleAndAuthor struct { + Type string `json:"type"` + ID int `json:"id"` + Title string `json:"title"` + TitleImage string `json:"title_image"` + URL string `json:"url"` + Excerpt string `json:"excerpt"` + Created int `json:"created"` + Updated int `json:"updated"` + Author Author +} + +type Topic struct { + Url string `json:"url"` + Id string `json:"id"` + Name string `json:"name"` +} + +type Article struct { + IsPinned int `json:"is_pinned"` + Pid int `json:"pid"` + CoverImg string `json:"cover_img"` + Title string `json:"title"` + PreviewText string `json:"preview_text"` + Content string `json:"content"` + PublishedAt time.Time `json:"published_at"` + Topics []Topic `json:"topics"` +} + +type ArticleList struct { + Paging struct { + IsEnd bool `json:"is_end"` + Totals int `json:"totals"` + IsStart bool `json:"is_start"` + } `json:"paging"` + Data []struct { + ID int `json:"id"` + } `json:"data"` +}